Class: CustomerGroupService
Provides layer to manipulate discounts.
implements {BaseService}
Hierarchy
"medusa-interfaces"↳
CustomerGroupService
Constructors
constructor
• new CustomerGroupService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters | CustomerGroupConstructorProps |
Overrides
BaseService.constructor
Defined in
Properties
customerGroupRepository_
• Private customerGroupRepository_: typeof CustomerGroupRepository
Defined in
customerService_
• Private customerService_: CustomerService
Defined in
manager_
• Private manager_: EntityManager
Defined in
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
services/customer-group.ts:113
create
▸ create(group): Promise<CustomerGroup>
Creates a customer group with the provided data.
Parameters
| Name | Type | Description |
|---|---|---|
group | DeepPartial<CustomerGroup> | the customer group to create |
Returns
Promise<CustomerGroup>
the result of the create operation
Defined in
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
services/customer-group.ts:194
list
▸ list(selector?, config): Promise<CustomerGroup[]>
List customer groups.
Parameters
| Name | Type | Description |
|---|---|---|
selector | FilterableCustomerGroupProps | 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
services/customer-group.ts:217
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 | FilterableCustomerGroupProps | 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
services/customer-group.ts:236
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
services/customer-group.ts:271
retrieve
▸ retrieve(id, config?): Promise<CustomerGroup>
Parameters
| Name | Type |
|---|---|
id | string |
config | Object |
Returns
Promise<CustomerGroup>
Defined in
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
services/customer-group.ts:162
withTransaction
▸ withTransaction(transactionManager): CustomerGroupService
Parameters
| Name | Type |
|---|---|
transactionManager | EntityManager |