Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionService.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

10 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: DiscountConditionService

internal.internal.DiscountConditionService

Provides layer to manipulate discount conditions.

Implements

Hierarchy

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


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-condition.d.ts:18


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/dist/services/discount-condition.d.ts:19


manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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


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

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


delete

delete(discountConditionId): Promise<void | DiscountCondition>

Parameters

Name Type
discountConditionId string

Returns

Promise<void | DiscountCondition>

Defined in

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


removeResources

removeResources(data): Promise<void>

Parameters

Name Type
data Omit<DiscountConditionInput, "id"> & { id: string }

Returns

Promise<void>

Defined in

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


retrieve

retrieve(conditionId, config?): Promise<DiscountCondition>

Parameters

Name Type
conditionId string
config? FindConfig<DiscountCondition>

Returns

Promise<DiscountCondition>

Defined in

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


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


upsertCondition

upsertCondition(data, overrideExisting?): Promise<(DiscountConditionCustomerGroup | DiscountConditionProduct | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionProductType)[]>

Parameters

Name Type
data DiscountConditionInput
overrideExisting? boolean

Returns

Promise<(DiscountConditionCustomerGroup | DiscountConditionProduct | DiscountConditionProductCollection | DiscountConditionProductTag | DiscountConditionProductType)[]>

Defined in

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


withTransaction

withTransaction(transactionManager?): DiscountConditionService

Parameters

Name Type
transactionManager? EntityManager

Returns

DiscountConditionService

Inherited from

TransactionBaseService.withTransaction

Defined in

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


resolveConditionType_

Static Protected resolveConditionType_(data): undefined | { resource_ids: (string | { id: string })[] ; type: DiscountConditionType }

Parameters

Name Type
data DiscountConditionInput

Returns

undefined | { resource_ids: (string | { id: string })[] ; type: DiscountConditionType }

Defined in

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