medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: DiscountService

internal.internal.DiscountService

Provides layer to manipulate discounts.

Implements

Hierarchy

• TransactionBaseService

  ↳ DiscountService

Properties

__configModule__

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

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

packages/medusa/dist/services/discount.d.ts:22

---

discountConditionRepository_

• Protected Readonly discountConditionRepository_: Repository<DiscountCondition> & { addConditionResources: (conditionId: string, resourceIds: (string | { id: string })[], type: DiscountConditionType, overrideExisting?: boolean) => Promise<(DiscountConditionCustomerGroup | DiscountConditionProduct | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionProductType)[]> ; canApplyForCustomer: (discountRuleId: string, customerId: string) => Promise<boolean> ; findOneWithDiscount: (conditionId: string, discountId: string) => Promise<undefined | DiscountCondition & { discount: Discount }> ; getJoinTableResourceIdentifiers: (type: string) => { conditionTable: DiscountConditionResourceType ; joinTable: string ; joinTableForeignKey: DiscountConditionJoinTableForeignKey ; joinTableKey: string ; relatedTable: string ; resourceKey: string } ; isValidForProduct: (discountRuleId: string, productId: string) => Promise<boolean> ; queryConditionTable: (__namedParameters: { conditionId: any ; resourceId: any ; type: any }) => Promise<number> ; removeConditionResources: (id: string, type: DiscountConditionType, resourceIds: (string | { id: string })[]) => Promise<void | DeleteResult> }

Defined in

packages/medusa/dist/services/discount.d.ts:25

---

discountConditionService_

• Protected Readonly discountConditionService_: DiscountConditionService

Defined in

packages/medusa/dist/services/discount.d.ts:26

---

discountRepository_

• Protected Readonly discountRepository_: Repository<Discount>

Defined in

packages/medusa/dist/services/discount.d.ts:21

---

discountRuleRepository_

• Protected Readonly discountRuleRepository_: Repository<DiscountRule>

Defined in

packages/medusa/dist/services/discount.d.ts:23

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/dist/services/discount.d.ts:31

---

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/dist/services/discount.d.ts:32

---

giftCardRepository_

• Protected Readonly giftCardRepository_: Repository<GiftCard> & { listGiftCardsAndCount: (query: ExtendedFindConfig<GiftCard>, q?: string) => Promise<[GiftCard[], number]> }

Defined in

packages/medusa/dist/services/discount.d.ts:24

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

newTotalsService_

• Protected Readonly newTotalsService_: NewTotalsService

Defined in

packages/medusa/dist/services/discount.d.ts:28

---

productService_

• Protected Readonly productService_: ProductService

Defined in

packages/medusa/dist/services/discount.d.ts:29

---

regionService_

• Protected Readonly regionService_: RegionService

Defined in

packages/medusa/dist/services/discount.d.ts:30

---

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

packages/medusa/dist/services/discount.d.ts:27

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

Methods

addRegion

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

Adds a region to the discount regions array.

Parameters

Name	Type	Description
discountId	string	id of discount
regionId	string	id of region to add

Returns

Promise<Discount>

the result of the update operation

Defined in

packages/medusa/dist/services/discount.d.ts:123

---

atomicPhase_

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

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
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the transactional work to be done
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:24

---

calculateDiscountForLineItem

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

Parameters

Name	Type
discountId	string
lineItem	LineItem
calculationContextData	CalculationContextData

Returns

Promise<number>

Defined in

packages/medusa/dist/services/discount.d.ts:138

---

canApplyForCustomer

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

Parameters

Name	Type
discountRuleId	string
customerId	undefined | string

Returns

Promise<boolean>

Defined in

packages/medusa/dist/services/discount.d.ts:146

---

create

▸ create(discount): Promise<Discount>

Creates a discount with provided data given that the data is validated. Normalizes discount code to uppercase.

Parameters

Name	Type	Description
discount	CreateDiscountInput	the discount data to create

Returns

Promise<Discount>

the result of the create operation

Defined in

packages/medusa/dist/services/discount.d.ts:74

---

createDynamicCode

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

Creates a dynamic code for a discount id.

Parameters

Name	Type	Description
discountId	string	the id of the discount to create a code for
data	CreateDynamicDiscountInput	the object containing a code to identify the discount by

Returns

Promise<Discount>

the newly created dynamic code

Defined in

packages/medusa/dist/services/discount.d.ts:109

---

delete

▸ delete(discountId): Promise<void>

Deletes a discount idempotently

Parameters

Name	Type	Description
discountId	string	id of discount to delete

Returns

Promise<void>

the result of the delete operation

Defined in

packages/medusa/dist/services/discount.d.ts:136

---

deleteDynamicCode

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

Deletes a dynamic code for a discount id.

Parameters

Name	Type	Description
discountId	string	the id of the discount to create a code for
code	string	the code to identify the discount by

Returns

Promise<void>

the newly created dynamic code

Defined in

packages/medusa/dist/services/discount.d.ts:116

---

hasCustomersGroupCondition

▸ hasCustomersGroupCondition(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

packages/medusa/dist/services/discount.d.ts:140

---

hasExpired

▸ hasExpired(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

packages/medusa/dist/services/discount.d.ts:143

---

hasNotStarted

▸ hasNotStarted(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

packages/medusa/dist/services/discount.d.ts:142

---

hasReachedLimit

▸ hasReachedLimit(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

packages/medusa/dist/services/discount.d.ts:141

---

isDisabled

▸ isDisabled(discount): boolean

Parameters

Name	Type
discount	Discount

Returns

boolean

Defined in

packages/medusa/dist/services/discount.d.ts:144

---

isValidForRegion

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

Parameters

Name	Type
discount	Discount
region_id	string

Returns

Promise<boolean>

Defined in

packages/medusa/dist/services/discount.d.ts:145

---

list

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

Parameters

Name	Type	Description
selector?	FilterableDiscountProps	the query object for find
config?	FindConfig<Discount>	the config object containing query settings

Returns

Promise<Discount[]>

the result of the find operation

Defined in

packages/medusa/dist/services/discount.d.ts:61

---

listAndCount

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

Parameters

Name	Type	Description
selector?	FilterableDiscountProps	the query object for find
config?	FindConfig<Discount>	the config object containing query settings

Returns

Promise<[Discount[], number]>

the result of the find operation

Defined in

packages/medusa/dist/services/discount.d.ts:67

---

listByCodes

▸ listByCodes(discountCodes, config?): Promise<Discount[]>

List all the discounts corresponding to the given codes

Parameters

Name	Type	Description
discountCodes	string[]	discount codes of discounts to retrieve
config?	FindConfig<Discount>	the config object containing query settings

Returns

Promise<Discount[]>

the discounts

Defined in

packages/medusa/dist/services/discount.d.ts:95

---

removeRegion

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

Removes a region from the discount regions array.

Parameters

Name	Type	Description
discountId	string	id of discount
regionId	string	id of region to remove

Returns

Promise<Discount>

the result of the update operation

Defined in

packages/medusa/dist/services/discount.d.ts:130

---

retrieve

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

Gets a discount by id.

Parameters

Name	Type	Description
discountId	string	id of discount to retrieve
config?	FindConfig<Discount>	the config object containing query settings

Returns

Promise<Discount>

the discount

Defined in

packages/medusa/dist/services/discount.d.ts:81

---

retrieveByCode

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

Gets the discount by discount code.

Parameters

Name	Type	Description
discountCode	string	discount code of discount to retrieve
config?	FindConfig<Discount>	the config object containing query settings

Returns

Promise<Discount>

the discount

Defined in

packages/medusa/dist/services/discount.d.ts:88

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

update

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

Updates a discount.

Parameters

Name	Type	Description
discountId	string	discount id of discount to update
update	UpdateDiscountInput	the data to update the discount with

Returns

Promise<Discount>

the result of the update operation

Defined in

packages/medusa/dist/services/discount.d.ts:102

---

validateDiscountForCartOrThrow

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

Parameters

Name	Type
cart	Cart
discount	Discount | Discount[]

Returns

Promise<void>

Defined in

packages/medusa/dist/services/discount.d.ts:139

---

validateDiscountForProduct

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

Parameters

Name	Type
discountRuleId	string
productId?	string

Returns

Promise<boolean>

Defined in

packages/medusa/dist/services/discount.d.ts:137

---

validateDiscountRule_

▸ validateDiscountRule_<T>(discountRule): T

Creates a discount rule with provided data given that the data is validated.

Type parameters

Name	Type
T	extends Object

Parameters

Name	Type	Description
discountRule	T	the discount rule to create

Returns

T

the result of the create operation

Defined in

packages/medusa/dist/services/discount.d.ts:52

---

withTransaction

▸ withTransaction(transactionManager?): DiscountService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

DiscountService

Inherited from

TransactionBaseService.withTransaction

Defined in

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