Files

Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994 )

* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client

2022-08-04 17:29:52 +03:00

17 KiB

Raw Blame History

Class: DiscountService

Provides layer to manipulate discounts.

Implements

Hierarchy

TransactionBaseService<DiscountService>

↳ DiscountService

Constructors

constructor

• new DiscountService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`Object`

Overrides

TransactionBaseService<DiscountService>.constructor

Defined in

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

Properties

configModule

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

Inherited from

TransactionBaseService.configModule

Defined in

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

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

Defined in

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

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

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

discountConditionRepository_

• Protected Readonly discountConditionRepository_: typeof DiscountConditionRepository

Defined in

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

discountConditionService_

• Protected Readonly discountConditionService_: DiscountConditionService

Defined in

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

discountRepository_

• Protected Readonly discountRepository_: typeof DiscountRepository

Defined in

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

discountRuleRepository_

• Protected Readonly discountRuleRepository_: typeof DiscountRuleRepository

Defined in

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

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

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

giftCardRepository_

• Protected Readonly giftCardRepository_: typeof GiftCardRepository

Defined in

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

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

productService_

• Protected Readonly productService_: ProductService

Defined in

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

regionService_

• Protected Readonly regionService_: RegionService

Defined in

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

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

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

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

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:465

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:53

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:566

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:710

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:176

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:393

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:525

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:444

hasExpired

▸ hasExpired(discount): boolean

Parameters

Name	Type
`discount`	`Discount`

Returns

boolean

Defined in

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

hasNotStarted

▸ hasNotStarted(discount): boolean

Parameters

Name	Type
`discount`	`Discount`

Returns

boolean

Defined in

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

hasReachedLimit

▸ hasReachedLimit(discount): boolean

Parameters

Name	Type
`discount`	`Discount`

Returns

boolean

Defined in

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

isDisabled

▸ isDisabled(discount): boolean

Parameters

Name	Type
`discount`	`Discount`

Returns

boolean

Defined in

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

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:691

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:114

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:130

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:500

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:241

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:267

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:34

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:298

validateDiscountForCartOrThrow

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

Parameters

Name	Type
`cart`	`Cart`
`discount`	`Discount`

Returns

Promise<void>

Defined in

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

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:539

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:96

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:16

17 KiB Raw Blame History

Class: DiscountService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

configModule

Inherited from

Defined in

container

Inherited from

Defined in

customerService_

Defined in

discountConditionRepository_

Defined in

discountConditionService_

Defined in

discountRepository_

Defined in

discountRuleRepository_

Defined in

eventBus_

Defined in

giftCardRepository_

Defined in

manager_

Overrides

Defined in

productService_

Defined in

regionService_

Defined in

totalsService_

Defined in

transactionManager_

Overrides

Defined in

Methods

addRegion

Parameters

Returns

Defined in

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

calculateDiscountForLineItem

Parameters

Returns

Defined in

canApplyForCustomer

Parameters

Returns

Defined in

create

Parameters

Returns

Defined in

createDynamicCode

Parameters

Returns

Defined in

delete

Parameters

Returns

Defined in

deleteDynamicCode

Parameters

Returns

Defined in

hasExpired

Parameters

Returns

Defined in

17 KiB

Raw Blame History