medusa-store/docs/content/references/services/classes/CustomerGroupService.md

Class: CustomerGroupService

Hierarchy

• "medusa-interfaces"

  ↳ CustomerGroupService

Constructors

constructor

• new CustomerGroupService(__namedParameters)

Parameters

Name	Type
__namedParameters	CustomerGroupConstructorProps

Overrides

BaseService.constructor

Defined in

services/customer-group.ts:31

Properties

customerGroupRepository_

• Private customerGroupRepository_: typeof CustomerGroupRepository

Defined in

services/customer-group.ts:27

---

customerService_

• Private customerService_: CustomerService

Defined in

services/customer-group.ts:29

---

manager_

• Private manager_: EntityManager

Defined in

services/customer-group.ts:25

Methods

addCustomers

▸ addCustomers(id, customerIds): Promise<CustomerGroup>

Parameters

Name	Type	Description
id	string
customerIds	string | string[]

Returns

Promise<CustomerGroup>

Defined in

services/customer-group.ts:113

---

create

▸ create(group): Promise<CustomerGroup>

Parameters

Name	Type	Description
group	Object
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>

Defined in

services/customer-group.ts:86

---

delete

▸ delete(groupId): Promise<void>

Parameters

Name	Type	Description
groupId	string

Returns

Promise<void>

Defined in

services/customer-group.ts:194

---

list

▸ list(selector?, config): Promise<CustomerGroup[]>

Parameters

Name	Type	Description
selector	FilterableCustomerGroupProps
config	FindConfig<CustomerGroup>

Returns

Promise<CustomerGroup[]>

Defined in

services/customer-group.ts:217

---

listAndCount

▸ listAndCount(selector?, config): Promise<[CustomerGroup[], number]>

Parameters

Name	Type	Description
selector	FilterableCustomerGroupProps
config	FindConfig<CustomerGroup>

Returns

Promise<[CustomerGroup[], number]>

Defined in

services/customer-group.ts:236

---

removeCustomer

▸ removeCustomer(id, customerIds): Promise<CustomerGroup>

Parameters

Name	Type	Description
id	string
customerIds	string | string[]

Returns

Promise<CustomerGroup>

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

services/customer-group.ts:62

---

update

▸ update(customerGroupId, update): Promise<CustomerGroup[]>

Parameters

Name	Type	Description
customerGroupId	string
update	CustomerGroupUpdate

Returns

Promise<CustomerGroup[]>

Defined in

services/customer-group.ts:162

---

withTransaction

▸ withTransaction(transactionManager): CustomerGroupService

Parameters

Name	Type
transactionManager	EntityManager

Returns

CustomerGroupService

Defined in

services/customer-group.ts:46