asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
fd2dcdf98c83daa23b2197f2a4da5022b281d73d
medusa-store/www/docs/content/references/services/classes/DiscountService.md
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770) 
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

20 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

medusa/src/services/discount.ts:71

Properties

__configModule__

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

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

__moduleDeclaration__

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

customerService_

• Protected Readonly customerService_: CustomerService

Defined in

medusa/src/services/discount.ts:58

discountConditionRepository_

• Protected Readonly discountConditionRepository_: Repository<DiscountCondition> & { addConditionResources: (conditionId: string, resourceIds: (string | { id: string })[], type: DiscountConditionType, overrideExisting: boolean) => Promise<(DiscountConditionProduct | DiscountConditionProductType | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionCustomerGroup)[]> ; 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 ; resourceKey: string } ; isValidForProduct: (discountRuleId: string, productId: string) => Promise<boolean> ; queryConditionTable: (__namedParameters: Object) => Promise<number> ; removeConditionResources: (id: string, type: DiscountConditionType, resourceIds: (string | { id: string })[]) => Promise<void | DeleteResult> }

Defined in

medusa/src/services/discount.ts:62

discountConditionService_

• Protected Readonly discountConditionService_: DiscountConditionService

Defined in

medusa/src/services/discount.ts:63

discountRepository_

• Protected Readonly discountRepository_: Repository<Discount>

Defined in

medusa/src/services/discount.ts:57

discountRuleRepository_

• Protected Readonly discountRuleRepository_: Repository<DiscountRule>

Defined in

medusa/src/services/discount.ts:59

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/discount.ts:68

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/discount.ts:69

giftCardRepository_

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

Defined in

medusa/src/services/discount.ts:60

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

newTotalsService_

• Protected Readonly newTotalsService_: NewTotalsService

Defined in

medusa/src/services/discount.ts:65

productService_

• Protected Readonly productService_: ProductService

Defined in

medusa/src/services/discount.ts:66

regionService_

• Protected Readonly regionService_: RegionService

Defined in

medusa/src/services/discount.ts:67

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

medusa/src/services/discount.ts:64

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

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

medusa/src/services/discount.ts:503

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

medusa/src/interfaces/transaction-base-service.ts:56

calculateDiscountForLineItem

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

Parameters

Name Type
discountId string
lineItem LineItem
calculationContextData CalculationContextData

Returns

Promise<number>

Defined in

medusa/src/services/discount.ts:605

canApplyForCustomer

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

Parameters

Name Type
discountRuleId string
customerId undefined | string

Returns

Promise<boolean>

Defined in

medusa/src/services/discount.ts:797

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

medusa/src/services/discount.ts:178

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

medusa/src/services/discount.ts:431

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

medusa/src/services/discount.ts:563

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

medusa/src/services/discount.ts:482

hasCustomersGroupCondition

▸ hasCustomersGroupCondition(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

medusa/src/services/discount.ts:750

hasExpired

▸ hasExpired(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

medusa/src/services/discount.ts:766

hasNotStarted

▸ hasNotStarted(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

medusa/src/services/discount.ts:762

hasReachedLimit

▸ hasReachedLimit(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

medusa/src/services/discount.ts:756

isDisabled

▸ isDisabled(discount): boolean

Parameters

Name Type
discount Discount

Returns

boolean

Defined in

medusa/src/services/discount.ts:774

isValidForRegion

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

Parameters

Name Type
discount Discount
region_id string

Returns

Promise<boolean>

Defined in

medusa/src/services/discount.ts:778

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

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

medusa/src/services/discount.ts:142

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

medusa/src/services/discount.ts:307

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

medusa/src/services/discount.ts:538

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

medusa/src/services/discount.ts:244

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

medusa/src/services/discount.ts:278

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

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

medusa/src/services/discount.ts:338

validateDiscountForCartOrThrow

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

Parameters

Name Type
cart Cart
discount Discount | Discount[]

Returns

Promise<void>

Defined in

medusa/src/services/discount.ts:678

validateDiscountForProduct

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

Parameters

Name Type
discountRuleId string
productId undefined | string

Returns

Promise<boolean>

Defined in

medusa/src/services/discount.ts:577

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

medusa/src/services/discount.ts:107

withTransaction

▸ withTransaction(transactionManager?): DiscountService

Parameters

Name Type
transactionManager? EntityManager

Returns

DiscountService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Reference in New Issue View Git Blame Copy Permalink