Class: CustomerGroupService

Hierarchy

• TransactionBaseServiceCopy to Clipboard

  ↳ CustomerGroupServiceCopy to Clipboard

Constructors

constructor

• new CustomerGroupService(__namedParametersCopy to Clipboard)

Parameters

Name	Type
__namedParametersCopy to Clipboard	CustomerGroupConstructorPropsCopy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/customer-group.ts:27

Properties

__configModule__

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

---

__container__

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

---

__moduleDeclaration__

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11

---

customerGroupRepository_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard customerGroupRepository_: typeof CustomerGroupRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/customer-group.ts:24

---

customerService_

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard customerService_: CustomerServiceCopy to Clipboard

Defined in

packages/medusa/src/services/customer-group.ts:25

---

manager_

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/customer-group.ts:21

---

transactionManager_

• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/customer-group.ts:22

Methods

addCustomers

▸ addCustomers(idCopy to Clipboard, customerIdsCopy to Clipboard): PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

Add a batch of customers to a customer group at once

Parameters

Name	Type	Description
idCopy to Clipboard	stringCopy to Clipboard	id of the customer group to add customers to
customerIdsCopy to Clipboard	stringCopy to Clipboard | stringCopy to Clipboard[]	customer id's to add to the group

Returns

PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

the customer group after insertion

Defined in

packages/medusa/src/services/customer-group.ts:94

---

atomicPhase_

▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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.

Type parameters

Name
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters

Name	Type	Description
workCopy to Clipboard	(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>	the transactional work to be done
isolationOrErrorHandler?Copy to Clipboard	IsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard	(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>	Potential error handler

Returns

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50

---

create

▸ create(groupCopy to Clipboard): PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

Creates a customer group with the provided data.

Parameters

Name	Type	Description
groupCopy to Clipboard	ObjectCopy to Clipboard	the customer group to create
group.created_at?Copy to Clipboard	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-
group.customers?Copy to Clipboard	(undefinedCopy to Clipboard | { 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?Copy to Clipboard	nullCopy to Clipboard | { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-
group.id?Copy to Clipboard	stringCopy to Clipboard	-
group.metadata?Copy to Clipboard	{ [x: string]: unknown; }	-
group.name?Copy to Clipboard	stringCopy to Clipboard	-
group.price_lists?Copy to Clipboard	(undefinedCopy to Clipboard | { 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?Copy to Clipboard	{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }	-

Returns

PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

the result of the create operation

Defined in

packages/medusa/src/services/customer-group.ts:70

---

delete

▸ delete(groupIdCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Remove customer group

Parameters

Name	Type	Description
groupIdCopy to Clipboard	stringCopy to Clipboard	id of the customer group to delete

Returns

PromiseCopy to Clipboard<voidCopy to Clipboard>

a promise

Defined in

packages/medusa/src/services/customer-group.ts:158

---

handleCreationFail

▸ PrivateCopy to Clipboard handleCreationFail(idCopy to Clipboard, idsCopy to Clipboard, errorCopy to Clipboard): PromiseCopy to Clipboard<neverCopy to Clipboard>

Parameters

Name	Type
idCopy to Clipboard	stringCopy to Clipboard
idsCopy to Clipboard	stringCopy to Clipboard[]
errorCopy to Clipboard	anyCopy to Clipboard

Returns

PromiseCopy to Clipboard<neverCopy to Clipboard>

Defined in

packages/medusa/src/services/customer-group.ts:261

---

list

▸ list(selector?Copy to Clipboard, configCopy to Clipboard): PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard[]>

List customer groups.

Parameters

Name	Type	Description
selectorCopy to Clipboard	SelectorCopy to Clipboard<CustomerGroupCopy to Clipboard> & { discount_condition_id?Copy to Clipboard: stringCopy to Clipboard ; q?Copy to Clipboard: stringCopy to Clipboard }	the query object for find
configCopy to Clipboard	FindConfigCopy to Clipboard<CustomerGroupCopy to Clipboard>	the config to be used for find

Returns

PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard[]>

the result of the find operation

Defined in

packages/medusa/src/services/customer-group.ts:181

---

listAndCount

▸ listAndCount(selector?Copy to Clipboard, configCopy to Clipboard): PromiseCopy to Clipboard<[CustomerGroupCopy to Clipboard[], numberCopy to Clipboard]>

Retrieve a list of customer groups and total count of records that match the query.

Parameters

Name	Type	Description
selectorCopy to Clipboard	SelectorCopy to Clipboard<CustomerGroupCopy to Clipboard> & { discount_condition_id?Copy to Clipboard: stringCopy to Clipboard ; q?Copy to Clipboard: stringCopy to Clipboard }	the query object for find
configCopy to Clipboard	FindConfigCopy to Clipboard<CustomerGroupCopy to Clipboard>	the config to be used for find

Returns

PromiseCopy to Clipboard<[CustomerGroupCopy to Clipboard[], numberCopy to Clipboard]>

the result of the find operation

Defined in

packages/medusa/src/services/customer-group.ts:199

---

removeCustomer

▸ removeCustomer(idCopy to Clipboard, customerIdsCopy to Clipboard): PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

Remove list of customers from a customergroup

Parameters

Name	Type	Description
idCopy to Clipboard	stringCopy to Clipboard	id of the customer group from which the customers are removed
customerIdsCopy to Clipboard	stringCopy to Clipboard | stringCopy to Clipboard[]	id's of the customer to remove from group

Returns

PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

the customergroup with the provided id

Defined in

packages/medusa/src/services/customer-group.ts:240

---

retrieve

▸ retrieve(customerGroupIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

Parameters

Name	Type
customerGroupIdCopy to Clipboard	stringCopy to Clipboard
configCopy to Clipboard	ObjectCopy to Clipboard

Returns

PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

Defined in

packages/medusa/src/services/customer-group.ts:40

---

shouldRetryTransaction_

▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters

Name	Type
errCopy to Clipboard	RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns

booleanCopy to Clipboard

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

---

update

▸ update(customerGroupIdCopy to Clipboard, updateCopy to Clipboard): PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

Update a customer group.

Parameters

Name	Type	Description
customerGroupIdCopy to Clipboard	stringCopy to Clipboard	id of the customer group
updateCopy to Clipboard	CustomerGroupUpdateCopy to Clipboard	customer group partial data

Returns

PromiseCopy to Clipboard<CustomerGroupCopy to Clipboard>

resulting customer group

Defined in

packages/medusa/src/services/customer-group.ts:125

---

withTransaction

▸ withTransaction(transactionManager?Copy to Clipboard): CustomerGroupServiceCopy to Clipboard

Parameters

Name	Type
transactionManager?Copy to Clipboard	EntityManagerCopy to Clipboard

Returns

CustomerGroupServiceCopy to Clipboard

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14