Skip to main content

Class: GiftCardService

Provides layer to manipulate gift cards.

Hierarchy

  • TransactionBaseService

    GiftCardService

Constructors

constructor

new GiftCardService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/gift-card.ts:47

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


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/gift-card.ts:38


giftCardRepository_

Protected Readonly giftCardRepository_: typeof GiftCardRepository

Defined in

packages/medusa/src/services/gift-card.ts:34


giftCardTransactionRepo_

Protected Readonly giftCardTransactionRepo_: typeof GiftCardTransactionRepository

Defined in

packages/medusa/src/services/gift-card.ts:36


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/gift-card.ts:40


regionService_

Protected Readonly regionService_: RegionService

Defined in

packages/medusa/src/services/gift-card.ts:37


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/gift-card.ts:41


Events

Static Events: Object

Type declaration

NameType
CREATEDstring

Defined in

packages/medusa/src/services/gift-card.ts:43

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

NameTypeDescription
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


create

create(giftCard): Promise<GiftCard>

Creates a gift card with provided data given that the data is validated.

Parameters

NameTypeDescription
giftCardCreateGiftCardInputthe gift card data to create

Returns

Promise<GiftCard>

the result of the create operation

Defined in

packages/medusa/src/services/gift-card.ts:153


createTransaction

createTransaction(data): Promise<string>

Parameters

NameType
dataCreateGiftCardTransactionInput

Returns

Promise<string>

Defined in

packages/medusa/src/services/gift-card.ts:138


delete

delete(giftCardId): Promise<void | GiftCard>

Deletes a gift card idempotently

Parameters

NameTypeDescription
giftCardIdstringid of gift card to delete

Returns

Promise<void | GiftCard>

the result of the delete operation

Defined in

packages/medusa/src/services/gift-card.ts:322


list

list(selector?, config?): Promise<GiftCard[]>

Parameters

NameTypeDescription
selectorQuerySelector<GiftCard>the query object for find
configFindConfig<GiftCard>the configuration used to find the objects. contains relations, skip, and take.

Returns

Promise<GiftCard[]>

the result of the find operation

Defined in

packages/medusa/src/services/gift-card.ts:114


listAndCount

listAndCount(selector?, config?): Promise<[GiftCard[], number]>

Parameters

NameTypeDescription
selectorQuerySelector<GiftCard>the query object for find
configFindConfig<GiftCard>the configuration used to find the objects. contains relations, skip, and take.

Returns

Promise<[GiftCard[], number]>

the result of the find operation

Defined in

packages/medusa/src/services/gift-card.ts:85


retrieve

retrieve(giftCardId, config?): Promise<GiftCard>

Gets a gift card by id.

Parameters

NameTypeDescription
giftCardIdstringid of gift card to retrieve
configFindConfig<GiftCard>optional values to include with gift card query

Returns

Promise<GiftCard>

the gift card

Defined in

packages/medusa/src/services/gift-card.ts:242


retrieveByCode

retrieveByCode(code, config?): Promise<GiftCard>

Parameters

NameType
codestring
configFindConfig<GiftCard>

Returns

Promise<GiftCard>

Defined in

packages/medusa/src/services/gift-card.ts:256


retrieve_

Protected retrieve_(selector, config?): Promise<GiftCard>

Parameters

NameType
selectorSelector<GiftCard>
configFindConfig<GiftCard>

Returns

Promise<GiftCard>

Defined in

packages/medusa/src/services/gift-card.ts:208


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


update

update(giftCardId, update): Promise<GiftCard>

Updates a giftCard.

Parameters

NameTypeDescription
giftCardIdstringgiftCard id of giftCard to update
updateUpdateGiftCardInputthe data to update the giftCard with

Returns

Promise<GiftCard>

the result of the update operation

Defined in

packages/medusa/src/services/gift-card.ts:276


withTransaction

withTransaction(transactionManager?): GiftCardService

Parameters

NameType
transactionManager?EntityManager

Returns

GiftCardService

Inherited from

TransactionBaseService.withTransaction

Defined in

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


generateCode

Static generateCode(): string

Generates a 16 character gift card code

Returns

string

the generated gift card code

Defined in

packages/medusa/src/services/gift-card.ts:69


resolveTaxRate

Static Protected resolveTaxRate(giftCardTaxRate, region): null | number

The tax_rate of the giftcard can depend on whether regions tax gift cards, an input provided by the user or the tax rate. Based on these conditions, tax_rate changes.

Parameters

NameType
giftCardTaxRatenull | number
regionRegion

Returns

null | number

the tax rate for the gift card

Defined in

packages/medusa/src/services/gift-card.ts:189