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

Class: DiscountService

Hierarchy

• TransactionBaseService<DiscountService>

  ↳ DiscountService

Constructors

constructor

• new DiscountService(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

Overrides

TransactionBaseService<DiscountService&gt;.constructor

Defined in

services/discount.ts:62

Properties

configModule

• Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

services/discount.ts:52

---

discountConditionRepository_

• Protected Readonly discountConditionRepository_: typeof DiscountConditionRepository

Defined in

services/discount.ts:55

---

discountConditionService_

• Protected Readonly discountConditionService_: DiscountConditionService

Defined in

services/discount.ts:56

---

discountRepository_

• Protected Readonly discountRepository_: typeof DiscountRepository

Defined in

services/discount.ts:51

---

discountRuleRepository_

• Protected Readonly discountRuleRepository_: typeof DiscountRuleRepository

Defined in

services/discount.ts:53

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

services/discount.ts:60

---

giftCardRepository_

• Protected Readonly giftCardRepository_: typeof GiftCardRepository

Defined in

services/discount.ts:54

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/discount.ts:48

---

productService_

• Protected Readonly productService_: ProductService

Defined in

services/discount.ts:58

---

regionService_

• Protected Readonly regionService_: RegionService

Defined in

services/discount.ts:59

---

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

services/discount.ts:57

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/discount.ts:49

Methods

addRegion

▸ addRegion(discountId, regionId): Promise<Discount>

Parameters

Name	Type	Description
discountId	string
regionId	string

Returns

Promise<Discount>

Defined in

services/discount.ts:477

---

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

calculateDiscountForLineItem

▸ calculateDiscountForLineItem(discountId, lineItem, cart): Promise<number>

Parameters

Name	Type
discountId	string
lineItem	LineItem
cart	Cart

Returns

Promise<number>

Defined in

services/discount.ts:576

---

canApplyForCustomer

▸ canApplyForCustomer(discountRuleId, customerId): Promise<boolean>

Parameters

Name	Type
discountRuleId	string
customerId	undefined | string

Returns

Promise<boolean>

Defined in

services/discount.ts:720

---

create

▸ create(discount): Promise<Discount>

Parameters

Name	Type	Description
discount	CreateDiscountInput

Returns

Promise<Discount>

Defined in

services/discount.ts:182

---

createDynamicCode

▸ createDynamicCode(discountId, data): Promise<Discount>

Parameters

Name	Type	Description
discountId	string
data	CreateDynamicDiscountInput

Returns

Promise<Discount>

Defined in

services/discount.ts:405

---

delete

▸ delete(discountId): Promise<void>

Parameters

Name	Type	Description
discountId	string

Returns

Promise<void>

Defined in

services/discount.ts:537

---

deleteDynamicCode

▸ deleteDynamicCode(discountId, code): Promise<void>

Parameters

Name	Type	Description
discountId	string
code	string

Returns

Promise<void>

Defined in

services/discount.ts:456

---

hasExpired

▸ hasExpired(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

services/discount.ts:689

---

hasNotStarted

▸ hasNotStarted(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

services/discount.ts:685

---

hasReachedLimit

▸ hasReachedLimit(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

services/discount.ts:679

---

isDisabled

▸ isDisabled(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

services/discount.ts:697

---

isValidForRegion

▸ isValidForRegion(discount, region_id): Promise<boolean>

Parameters

Name	Type
discount	Discount
region_id	string

Returns

Promise<boolean>

Defined in

services/discount.ts:701

---

list

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

Parameters

Name	Type	Description
selector	FilterableDiscountProps
config	FindConfig<Discount>

Returns

Promise<Discount[]>

Defined in

services/discount.ts:114

---

listAndCount

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

Parameters

Name	Type	Description
selector	FilterableDiscountProps
config	FindConfig<Discount>

Returns

Promise<[Discount[], number]>

Defined in

services/discount.ts:133

---

removeRegion

▸ removeRegion(discountId, regionId): Promise<Discount>

Parameters

Name	Type	Description
discountId	string
regionId	string

Returns

Promise<Discount>

Defined in

services/discount.ts:512

---

retrieve

▸ retrieve(discountId, config?): Promise<Discount>

Parameters

Name	Type	Description
discountId	string
config	FindConfig<Discount>

Returns

Promise<Discount>

Defined in

services/discount.ts:247

---

retrieveByCode

▸ retrieveByCode(discountCode, config?): Promise<Discount>

Parameters

Name	Type	Description
discountCode	string
config	FindConfig<Discount>

Returns

Promise<Discount>

Defined in

services/discount.ts:276

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

update

▸ update(discountId, update): Promise<Discount>

Parameters

Name	Type	Description
discountId	string
update	UpdateDiscountInput

Returns

Promise<Discount>

Defined in

services/discount.ts:310

---

validateDiscountForCartOrThrow

▸ validateDiscountForCartOrThrow(cart, discount): Promise<void>

Parameters

Name	Type
cart	Cart
discount	Discount

Returns

Promise<void>

Defined in

services/discount.ts:619

---

validateDiscountForProduct

▸ validateDiscountForProduct(discountRuleId, productId): Promise<boolean>

Parameters

Name	Type
discountRuleId	string
productId	undefined | string

Returns

Promise<boolean>

Defined in

services/discount.ts:551

---

validateDiscountRule_

▸ validateDiscountRule_<T>(discountRule): T

Type parameters

Name	Type
T	extends Object

Parameters

Name	Type	Description
discountRule	T

Returns

T

Defined in

services/discount.ts:96

---

withTransaction

▸ withTransaction(transactionManager?): DiscountService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

DiscountService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16