02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
7.8 KiB
Class: CustomerGroupService
Provides layer to manipulate discounts.
Implements
Hierarchy
-
"medusa-interfaces"↳
CustomerGroupService
Constructors
constructor
• new CustomerGroupService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
CustomerGroupConstructorProps |
Overrides
BaseService.constructor
Defined in
packages/medusa/src/services/customer-group.ts:31
Properties
customerGroupRepository_
• Private customerGroupRepository_: typeof CustomerGroupRepository
Defined in
packages/medusa/src/services/customer-group.ts:27
customerService_
• Private customerService_: CustomerService
Defined in
packages/medusa/src/services/customer-group.ts:29
manager_
• Private manager_: EntityManager
Defined in
packages/medusa/src/services/customer-group.ts:25
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:113
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; ... 6 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:86
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: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
packages/medusa/src/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
packages/medusa/src/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
packages/medusa/src/services/customer-group.ts:271
retrieve
▸ retrieve(id, config?): Promise<CustomerGroup>
Parameters
| Name | Type |
|---|---|
id |
string |
config |
Object |
Returns
Promise<CustomerGroup>
Defined in
packages/medusa/src/services/customer-group.ts:62
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:162
withTransaction
▸ withTransaction(transactionManager): CustomerGroupService
Parameters
| Name | Type |
|---|---|
transactionManager |
EntityManager |