284 lines
7.9 KiB
Markdown
284 lines
7.9 KiB
Markdown
# 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:32](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L32)
|
|
|
|
## Properties
|
|
|
|
### customerGroupRepository\_
|
|
|
|
• `Private` **customerGroupRepository\_**: typeof `CustomerGroupRepository`
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L28)
|
|
|
|
___
|
|
|
|
### customerService\_
|
|
|
|
• `Private` **customerService\_**: [`CustomerService`](CustomerService.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L30)
|
|
|
|
___
|
|
|
|
### manager\_
|
|
|
|
• `Private` **manager\_**: `EntityManager`
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/customer-group.ts:26](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L26)
|
|
|
|
## 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:114](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L114)
|
|
|
|
___
|
|
|
|
### 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:87](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L87)
|
|
|
|
___
|
|
|
|
### 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:195](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L195)
|
|
|
|
___
|
|
|
|
### 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:218](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L218)
|
|
|
|
___
|
|
|
|
### 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:237](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L237)
|
|
|
|
___
|
|
|
|
### 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:272](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L272)
|
|
|
|
___
|
|
|
|
### 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:63](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L63)
|
|
|
|
___
|
|
|
|
### 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:163](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L163)
|
|
|
|
___
|
|
|
|
### withTransaction
|
|
|
|
▸ **withTransaction**(`transactionManager`): [`CustomerGroupService`](CustomerGroupService.md)
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `transactionManager` | `EntityManager` |
|
|
|
|
#### Returns
|
|
|
|
[`CustomerGroupService`](CustomerGroupService.md)
|
|
|
|
#### Defined in
|
|
|
|
[packages/medusa/src/services/customer-group.ts:47](https://github.com/medusajs/medusa/blob/3efeb6b84/packages/medusa/src/services/customer-group.ts#L47)
|