CustomerGroupService
Hierarchy
TransactionBaseService↳
CustomerGroupService
Constructors
constructor
new CustomerGroupService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/customer-group.ts:24
Properties
__configModule__
Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
customerGroupRepository_
Protected Readonly customerGroupRepository_: Repository<CustomerGroup> & { addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }
Defined in
medusa/src/services/customer-group.ts:21
customerService_
Protected Readonly customerService_: CustomerService
Defined in
medusa/src/services/customer-group.ts:22
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
transactionManager_
Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-EntityManager:
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
addCustomers
addCustomers(id, customerIds): Promise<CustomerGroup>
Add a batch of customers to a customer group at once
Parameters
| Name | Description |
|---|---|
id | string |
customerIds | string | string[] |
Returns
Promise<CustomerGroup>
-Promise: the customer group after insertion
-CustomerGroup:
Defined in
medusa/src/services/customer-group.ts:89
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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
create
create(group): Promise<CustomerGroup>
Creates a customer group with the provided data.
Parameters
| Name | Description |
|---|---|
group | DeepPartial<CustomerGroup> |
Returns
Promise<CustomerGroup>
-Promise: the result of the create operation
-CustomerGroup:
Defined in
medusa/src/services/customer-group.ts:65
delete
delete(groupId): Promise<void>
Remove customer group
Parameters
| Name | Description |
|---|---|
groupId | string |
Returns
Promise<void>
-Promise: a promise
Defined in
medusa/src/services/customer-group.ts:153
handleCreationFail
Private handleCreationFail(id, ids, error): Promise<never>
Parameters
| Name |
|---|
id |
ids |
error |
Returns
Promise<never>
-Promise:
-never: (optional)
Defined in
medusa/src/services/customer-group.ts:257
list
list(selector?, config): Promise<CustomerGroup[]>
List customer groups.
Parameters
| Name | Description |
|---|---|
selector | Selector<CustomerGroup> & { discount_condition_id?: string ; q?: string } |
config | FindConfig<CustomerGroup> |
Returns
Promise<CustomerGroup[]>
-Promise: the result of the find operation
-CustomerGroup[]:
-CustomerGroup:
Defined in
medusa/src/services/customer-group.ts:176
listAndCount
listAndCount(selector?, config): Promise<[CustomerGroup[], number]>
Retrieve a list of customer groups and total count of records that match the query.
Parameters
| Name | Description |
|---|---|
selector | Selector<CustomerGroup> & { discount_condition_id?: string ; q?: string } |
config | FindConfig<CustomerGroup> |
Returns
Promise<[CustomerGroup[], number]>
-Promise: the result of the find operation
-CustomerGroup[]:
-number: (optional)
Defined in
medusa/src/services/customer-group.ts:194
removeCustomer
removeCustomer(id, customerIds): Promise<CustomerGroup>
Remove list of customers from a customergroup
Parameters
| Name | Description |
|---|---|
id | string |
customerIds | string | string[] |
Returns
Promise<CustomerGroup>
-Promise: the customergroup with the provided id
-CustomerGroup:
Defined in
medusa/src/services/customer-group.ts:236
retrieve
retrieve(customerGroupId, config?): Promise<CustomerGroup>
Parameters
| Name |
|---|
customerGroupId |
config |
Returns
Promise<CustomerGroup>
-Promise:
-CustomerGroup:
Defined in
medusa/src/services/customer-group.ts:35
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
update(customerGroupId, update): Promise<CustomerGroup>
Update a customer group.
Parameters
| Name | Description |
|---|---|
customerGroupId | string |
update | CustomerGroupUpdate |
Returns
Promise<CustomerGroup>
-Promise: resulting customer group
-CustomerGroup:
Defined in
medusa/src/services/customer-group.ts:120
withTransaction
withTransaction(transactionManager?): CustomerGroupService
Parameters
| Name |
|---|
transactionManager? |
Returns
-CustomerGroupService:
Inherited from
TransactionBaseService.withTransaction