Class: CustomerGroupService
Hierarchy
TransactionBaseService↳
CustomerGroupService
Constructors
constructor
• new CustomerGroupService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters | CustomerGroupConstructorProps |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/customer-group.ts:27
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
customerGroupRepository_
• Protected Readonly customerGroupRepository_: typeof CustomerGroupRepository
Defined in
packages/medusa/src/services/customer-group.ts:24
customerService_
• Protected Readonly customerService_: CustomerService
Defined in
packages/medusa/src/services/customer-group.ts:25
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/customer-group.ts:21
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/customer-group.ts:22
Methods
addCustomers
▸ addCustomers(id, customerIds): Promise<CustomerGroup>
Add a batch of customers to a customer group at once
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of the customer group to add customers to |
customerIds | string | string[] | customer id's to add to the group |
Returns
Promise<CustomerGroup>
the customer group after insertion
Defined in
packages/medusa/src/services/customer-group.ts:94
atomicPhase_
▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>
Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.
Type parameters
| Name |
|---|
TResult |
TError |
Parameters
| Name | Type | Description |
|---|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> | the transactional work to be done |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> | Potential error handler |
Returns
Promise<TResult>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:50
create
▸ create(group): Promise<CustomerGroup>
Creates a customer group with the provided data.
Parameters
| Name | Type | Description |
|---|---|---|
group | Object | the customer group to create |
group.created_at? | { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; } | - |
group.customers? | (undefined | { email?: string | undefined; first_name?: string | undefined; last_name?: string | undefined; billing_address_id?: string | null | undefined; billing_address?: { customer_id?: string | null | undefined; ... 16 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 10 more ...; updated_at?: { ...; } | undef...)[] | - |
group.deleted_at? | null | { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; } | - |
group.id? | string | - |
group.metadata? | { [x: string]: unknown; } | - |
group.name? | string | - |
group.price_lists? | (undefined | { name?: string | undefined; description?: string | undefined; type?: PriceListType | undefined; status?: PriceListStatus | undefined; starts_at?: { ...; } | ... 1 more ... | undefined; ... 7 more ...; updated_at?: { ...; } | undefined; })[] | - |
group.updated_at? | { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; } | - |
Returns
Promise<CustomerGroup>
the result of the create operation
Defined in
packages/medusa/src/services/customer-group.ts:70
delete
▸ delete(groupId): Promise<void>
Remove customer group
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | id of the customer group to delete |
Returns
Promise<void>
a promise
Defined in
packages/medusa/src/services/customer-group.ts:158
handleCreationFail
▸ Private handleCreationFail(id, ids, error): Promise<never>
Parameters
| Name | Type |
|---|---|
id | string |
ids | string[] |
error | any |
Returns
Promise<never>
Defined in
packages/medusa/src/services/customer-group.ts:261
list
▸ list(selector?, config): Promise<CustomerGroup[]>
List customer groups.
Parameters
| Name | Type | Description |
|---|---|---|
selector | Selector<CustomerGroup> & { discount_condition_id?: string ; q?: string } | the query object for find |
config | FindConfig<CustomerGroup> | the config to be used for find |
Returns
Promise<CustomerGroup[]>
the result of the find operation
Defined in
packages/medusa/src/services/customer-group.ts:181
listAndCount
▸ listAndCount(selector?, config): Promise<[CustomerGroup[], number]>
Retrieve a list of customer groups and total count of records that match the query.
Parameters
| Name | Type | Description |
|---|---|---|
selector | Selector<CustomerGroup> & { discount_condition_id?: string ; q?: string } | the query object for find |
config | FindConfig<CustomerGroup> | the config to be used for find |
Returns
Promise<[CustomerGroup[], number]>
the result of the find operation
Defined in
packages/medusa/src/services/customer-group.ts:199
removeCustomer
▸ removeCustomer(id, customerIds): Promise<CustomerGroup>
Remove list of customers from a customergroup
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of the customer group from which the customers are removed |
customerIds | string | string[] | id's of the customer to remove from group |
Returns
Promise<CustomerGroup>
the customergroup with the provided id
Defined in
packages/medusa/src/services/customer-group.ts:240
retrieve
▸ retrieve(customerGroupId, config?): Promise<CustomerGroup>
Parameters
| Name | Type |
|---|---|
customerGroupId | string |
config | Object |
Returns
Promise<CustomerGroup>
Defined in
packages/medusa/src/services/customer-group.ts:40
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err | Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(customerGroupId, update): Promise<CustomerGroup>
Update a customer group.
Parameters
| Name | Type | Description |
|---|---|---|
customerGroupId | string | id of the customer group |
update | CustomerGroupUpdate | customer group partial data |
Returns
Promise<CustomerGroup>
resulting customer group
Defined in
packages/medusa/src/services/customer-group.ts:125
withTransaction
▸ withTransaction(transactionManager?): CustomerGroupService
Parameters
| Name | Type |
|---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14