asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
7a9740bad70893f5fb33e426c334e50d43b60a4e
medusa-store/docs/content/references/services/classes/DiscountService.md
Shahed Nasser 6f1b49af03 chore: merge docs from master to develop (#3650) 
* Fix issue on fixed total amount discount when using includes tax (#3472)

The calculation of the fixed discount amount breaks when having includes_tax setting active, due to the line item totals are incorrect and returning everything as 0, thus the totalItemPercentage will be Infinitiy due to the division by a subtotal of 0

* chore: Add missing changeset for @medusajs/medusa

* feat(medusa): Improve performance of Products domain (#3417)

* feat(medusa): Improve product update performances

* fix tests and update

* update mock repo

* improve repo

* cleanup

* fix

* cleanup + bulk emit + unit test fix

* improvements

* improve

* fix unit tests

* fix export

* fix product update handler

* enhance mock repo

* fix import integration

* fix end point tests

* revert mock repo product variant

* fix unit

* cleanup

* cleanup

* address feedback

* fix quotes in tests

* address feedback

* Create new-tips-mate.md

* use types

* chore: Remove integration-tests from changeset

* chore(release): v1.7.14

* chore(docs): Generated Docs Announcement Bar (automated) (#3489)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* fix(medusa): EventBusService.emit using Redis mock (#3491)

* Fix eventBusService.emit using redis mock

* revert gitignore

* enqueuer

* unit test add redis_url

* fix test

* chore(docs): Generated Services Reference (automated) (#3490)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* docs: publish restructure (#3496)

* docs: added features and guides overview page

* added image

* added version 2

* added version 3

* added version 4

* docs: implemented new color scheme

* docs: redesigned sidebar (#3193)

* docs: redesigned navbar for restructure (#3199)

* docs: redesigned footer (#3209)

* docs: redesigned cards (#3230)

* docs: redesigned admonitions (#3231)

* docs: redesign announcement bar (#3236)

* docs: redesigned large cards (#3239)

* docs: redesigned code blocks (#3253)

* docs: redesigned search modal and page (#3264)

* docs: redesigned doc footer (#3268)

* docs: added new sidebars + refactored css and assets (#3279)

* docs: redesigned api reference sidebar

* docs: refactored css

* docs: added code tabs transition

* docs: added new sidebars

* removed unused assets

* remove unusued assets

* Fix deploy errors

* fix incorrect link

* docs: fixed code responsivity + missing icons (#3283)

* docs: changed icons (#3296)

* docs: design fixes to the sidebar (#3297)

* redesign fixes

* docs: small design fixes

* docs: several design fixes after restructure (#3299)

* docs: bordered icon fixes

* docs: desgin fixes

* fixes to code blocks and sidebar scroll

* design adjustments

* docs: restructured homepage (#3305)

* docs: restructured homepage

* design fixes

* fixed core concepts icon

* docs: added core concepts page (#3318)

* docs: restructured homepage

* design fixes

* docs: added core concepts page

* changed text of different components

* docs: added architecture link

* added missing prop for user guide

* docs: added regions overview page (#3327)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page (#3331)

* docs: added regions overview

* moved region pages to new structure

* docs: fixed description of regions architecture page

* small changes

* small fix

* docs: added customers overview page

* fix link

* resolve link issues

* docs: updated regions architecture image

* docs: second-iteration fixes (#3347)

* docs: redesigned document

* design fixes

* docs: added products overview page (#3354)

* docs: added carts overview page (#3363)

* docs: added orders overview (#3364)

* docs: added orders overview

* added links in overview

* docs: added vercel redirects

* docs: added soon badge for cards (#3389)

* docs: resolved feedback changes + organized troubleshooting pages (#3409)

* docs: resolved feedback changes

* added extra line

* docs: changed icons for restructure (#3421)

* docs: added taxes overview page (#3422)

* docs: added taxes overview page

* docs: fix sidebar label

* added link to taxes overview page

* fixed link

* docs: fixed sidebar scroll (#3429)

* docs: added discounts overview (#3432)

* docs: added discounts overview

* fixed links

* docs: added gift cards overview (#3433)

* docs: added price lists overview page (#3440)

* docs: added price lists overview page

* fixed links

* docs: added sales channels overview page (#3441)

* docs: added sales overview page

* fixed links

* docs: added users overview (#3443)

* docs: fixed sidebar border height (#3444)

* docs: fixed sidebar border height

* fixed svg markup

* docs: added possible solutions to feedback component (#3449)

* docs: added several overview pages + restructured files (#3463)

* docs: added several overview pages

* fixed links

* docs: added feature flags + PAK overview pages (#3464)

* docs: added feature flags + PAK overview pages

* fixed links

* fix link

* fix link

* fixed links colors

* docs: added strategies overview page (#3468)

* docs: automated upgrade guide (#3470)

* docs: automated upgrade guide

* fixed vercel redirect

* docs: restructured files in docs codebase (#3475)

* docs: restructured files

* docs: fixed eslint exception

* docs: finished restructure loose-ends (#3493)

* fixed uses of backend

* docs: finished loose ends

* eslint fixes

* fixed links

* merged master

* added update instructions for v1.7.12

* docs: fixed discount details (#3499)

* docs: fix trailing slash causing 404 (#3508)

* docs: fix error during navigation (#3509)

* docs: removed the gatsby storefront guide (#3527)

* docs: removed the gatsby storefront guide

* docs: fixed query value

* chore(docs): Removed Docs Announcement Bar (automated) (#3536)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity (#3539)

* fix(medusa): Variant update should include the id for the listeners to be able to identify the entity

* fix unit tests

* Create brave-seahorses-film.md

* docs: fix admin redirects (#3548)

* chore(release): v1.7.15

* chore(docs): Generated Docs Announcement Bar (automated) (#3550)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>

* chore(docs): Generated Services Reference (automated) (#3551)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore: updated READMEs of plugins (#3546)

* chore: updated READMEs of plugins

* added notice to plugins

* docs: added a deploy guide for next.js storefront (#3558)

* docs: added a deploy next.js guide

* docs: fix image zoom

* docs: fixes to next.js deployment guide to vercel (#3562)

* chore(workflows): Enable manual workflow in pre-release mode (#3566)

* chore(docs): Removed Docs Announcement Bar (automated) (#3598)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

* fix(medusa): Rounding issues on line item adjustments (#3446)

* chores(medusa): Attempt to fix discount rounding issues

* add migration

* update entities

* apply multipler factor properly

* fix discount service

* WIP

* fix rounding issues in discounts

* fix some tests

* Exclude raw_discount_total from responses

* fix adjustments

* cleanup response

* fix

* fix draft order integration

* fix order integration

* fix order integration

* address feedback

* fix test

* Create .changeset/polite-llamas-sit.md

* remove comment

---------

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>

* chore(workflows): Add release notification (#3629)

---------

Co-authored-by: pepijn-vanvlaanderen <pepijn@webbers.com>
Co-authored-by: olivermrbl <oliver@mrbltech.com>
Co-authored-by: Adrien de Peretti <adrien.deperetti@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-03-31 09:34:38 +02:00

18 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:69

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

__moduleDeclaration__

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

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

discountConditionRepository_

• Protected Readonly discountConditionRepository_: typeof DiscountConditionRepository

Defined in

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

discountConditionService_

• Protected Readonly discountConditionService_: DiscountConditionService

Defined in

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

discountRepository_

• Protected Readonly discountRepository_: typeof DiscountRepository

Defined in

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

discountRuleRepository_

• Protected Readonly discountRuleRepository_: typeof DiscountRuleRepository

Defined in

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

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

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

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

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

giftCardRepository_

• Protected Readonly giftCardRepository_: typeof GiftCardRepository

Defined in

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

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

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

newTotalsService_

• Protected Readonly newTotalsService_: NewTotalsService

Defined in

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

productService_

• Protected Readonly productService_: ProductService

Defined in

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

regionService_

• Protected Readonly regionService_: RegionService

Defined in

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

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

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

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

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

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

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, calculationContextData): Promise<number>

Parameters

Name Type
discountId string
lineItem LineItem
calculationContextData CalculationContextData

Returns

Promise<number>

Defined in

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

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

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

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

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

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

hasExpired

▸ hasExpired(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

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

hasNotStarted

▸ hasNotStarted(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

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

hasReachedLimit

▸ hasReachedLimit(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

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

isDisabled

▸ isDisabled(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

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

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

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

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

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

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

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

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

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

validateDiscountForCartOrThrow

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

Parameters

Name Type
cart Cart
discount Discount | Discount[]

Returns

Promise<void>

Defined in

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

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

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

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

Reference in New Issue View Git Blame Copy Permalink