asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
ee8a71c692b927bb60d3e794e22ab7ac9ce09d4a
medusa-store/docs/content/references/services/classes/DiscountService.md
github-actions[bot] 23bf4eb192 chore(docs): Generated Services Reference (automated) (#2399) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-10-10 19:31:16 +03:00

17 KiB
Raw Blame History

Class: DiscountService

Provides layer to manipulate discounts.

Implements

Hierarchy

  • TransactionBaseService

    ↳ DiscountService

Constructors

constructor

• new DiscountService(__namedParameters)

Parameters

Name Type
__namedParameters Object

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/discount.ts:66

Properties

__configModule__

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

Inherited from

TransactionBaseService.__configModule__

Defined in

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

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

packages/medusa/src/services/discount.ts:54

discountConditionRepository_

• Protected Readonly discountConditionRepository_: typeof DiscountConditionRepository

Defined in

packages/medusa/src/services/discount.ts:58

discountConditionService_

• Protected Readonly discountConditionService_: DiscountConditionService

Defined in

packages/medusa/src/services/discount.ts:59

discountRepository_

• Protected Readonly discountRepository_: typeof DiscountRepository

Defined in

packages/medusa/src/services/discount.ts:53

discountRuleRepository_

• Protected Readonly discountRuleRepository_: typeof DiscountRuleRepository

Defined in

packages/medusa/src/services/discount.ts:55

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/discount.ts:63

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/src/services/discount.ts:64

giftCardRepository_

• Protected Readonly giftCardRepository_: typeof GiftCardRepository

Defined in

packages/medusa/src/services/discount.ts:56

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/discount.ts:50

productService_

• Protected Readonly productService_: ProductService

Defined in

packages/medusa/src/services/discount.ts:61

regionService_

• Protected Readonly regionService_: RegionService

Defined in

packages/medusa/src/services/discount.ts:62

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

packages/medusa/src/services/discount.ts:60

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/discount.ts:51

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/src/services/discount.ts:473

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/src/interfaces/transaction-base-service.ts:50

calculateDiscountForLineItem

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

Parameters

Name Type
discountId string
lineItem LineItem
cart Cart

Returns

Promise<number>

Defined in

packages/medusa/src/services/discount.ts:574

canApplyForCustomer

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

Parameters

Name Type
discountRuleId string
customerId undefined | string

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/discount.ts:733

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/src/services/discount.ts:182

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/src/services/discount.ts:401

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/src/services/discount.ts:533

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/src/services/discount.ts:452

hasExpired

▸ hasExpired(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:702

hasNotStarted

▸ hasNotStarted(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:698

hasReachedLimit

▸ hasReachedLimit(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:692

isDisabled

▸ isDisabled(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:710

isValidForRegion

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

Parameters

Name Type
discount Discount
region_id string

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/discount.ts:714

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/src/services/discount.ts:120

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/src/services/discount.ts:136

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/src/services/discount.ts:508

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/src/services/discount.ts:245

retrieveByCode

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

Gets a 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 document

Defined in

packages/medusa/src/services/discount.ts:271

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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

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/src/services/discount.ts:304

validateDiscountForCartOrThrow

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

Parameters

Name Type
cart Cart
discount Discount

Returns

Promise<void>

Defined in

packages/medusa/src/services/discount.ts:632

validateDiscountForProduct

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

Parameters

Name Type
discountRuleId string
productId undefined | string

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/discount.ts:547

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/src/services/discount.ts:102

withTransaction

▸ withTransaction(transactionManager?): DiscountService

Parameters

Name Type
transactionManager? EntityManager

Returns

DiscountService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

Reference in New Issue View Git Blame Copy Permalink