Class: GiftCardService
Provides layer to manipulate gift cards.
Hierarchy
TransactionBaseServiceCopy to Clipboard↳
GiftCardServiceCopy to Clipboard
Constructors
constructor
• new GiftCardService(__namedParametersCopy to Clipboard)
Parameters
| Name | Type |
|---|---|
__namedParametersCopy to Clipboard | InjectedDependenciesCopy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/gift-card.ts:47
Properties
__configModule__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
eventBus_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBus_: EventBusServiceCopy to Clipboard
Defined in
packages/medusa/src/services/gift-card.ts:38
giftCardRepository_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard giftCardRepository_: typeof GiftCardRepositoryCopy to Clipboard
Defined in
packages/medusa/src/services/gift-card.ts:34
giftCardTransactionRepo_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard giftCardTransactionRepo_: typeof GiftCardTransactionRepositoryCopy to Clipboard
Defined in
packages/medusa/src/services/gift-card.ts:36
manager_
• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/gift-card.ts:40
regionService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard regionService_: RegionServiceCopy to Clipboard
Defined in
packages/medusa/src/services/gift-card.ts:37
transactionManager_
• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/gift-card.ts:41
Events
▪ StaticCopy to Clipboard Events: ObjectCopy to Clipboard
Type declaration
| Name | Type |
|---|---|
CREATEDCopy to Clipboard | stringCopy to Clipboard |
Defined in
packages/medusa/src/services/gift-card.ts:43
Methods
atomicPhase_
▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>
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 |
|---|
TResultCopy to Clipboard |
TErrorCopy to Clipboard |
Parameters
| Name | Type | Description |
|---|---|---|
workCopy to Clipboard | (transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler?Copy to Clipboard | IsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail?Copy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | Potential error handler |
Returns
PromiseCopy to Clipboard<TResultCopy to Clipboard>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:50
create
▸ create(giftCardCopy to Clipboard): PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
Creates a gift card with provided data given that the data is validated.
Parameters
| Name | Type | Description |
|---|---|---|
giftCardCopy to Clipboard | CreateGiftCardInputCopy to Clipboard | the gift card data to create |
Returns
PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
the result of the create operation
Defined in
packages/medusa/src/services/gift-card.ts:153
createTransaction
▸ createTransaction(dataCopy to Clipboard): PromiseCopy to Clipboard<stringCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
dataCopy to Clipboard | CreateGiftCardTransactionInputCopy to Clipboard |
Returns
PromiseCopy to Clipboard<stringCopy to Clipboard>
Defined in
packages/medusa/src/services/gift-card.ts:138
delete
▸ delete(giftCardIdCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard | GiftCardCopy to Clipboard>
Deletes a gift card idempotently
Parameters
| Name | Type | Description |
|---|---|---|
giftCardIdCopy to Clipboard | stringCopy to Clipboard | id of gift card to delete |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard | GiftCardCopy to Clipboard>
the result of the delete operation
Defined in
packages/medusa/src/services/gift-card.ts:322
list
▸ list(selector?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<GiftCardCopy to Clipboard[]>
Parameters
| Name | Type | Description |
|---|---|---|
selectorCopy to Clipboard | QuerySelectorCopy to Clipboard<GiftCardCopy to Clipboard> | the query object for find |
configCopy to Clipboard | FindConfigCopy to Clipboard<GiftCardCopy to Clipboard> | the configuration used to find the objects. contains relations, skip, and take. |
Returns
PromiseCopy to Clipboard<GiftCardCopy to Clipboard[]>
the result of the find operation
Defined in
packages/medusa/src/services/gift-card.ts:114
listAndCount
▸ listAndCount(selector?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<[GiftCardCopy to Clipboard[], numberCopy to Clipboard]>
Parameters
| Name | Type | Description |
|---|---|---|
selectorCopy to Clipboard | QuerySelectorCopy to Clipboard<GiftCardCopy to Clipboard> | the query object for find |
configCopy to Clipboard | FindConfigCopy to Clipboard<GiftCardCopy to Clipboard> | the configuration used to find the objects. contains relations, skip, and take. |
Returns
PromiseCopy to Clipboard<[GiftCardCopy to Clipboard[], numberCopy to Clipboard]>
the result of the find operation
Defined in
packages/medusa/src/services/gift-card.ts:85
retrieve
▸ retrieve(giftCardIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
Gets a gift card by id.
Parameters
| Name | Type | Description |
|---|---|---|
giftCardIdCopy to Clipboard | stringCopy to Clipboard | id of gift card to retrieve |
configCopy to Clipboard | FindConfigCopy to Clipboard<GiftCardCopy to Clipboard> | optional values to include with gift card query |
Returns
PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
the gift card
Defined in
packages/medusa/src/services/gift-card.ts:242
retrieveByCode
▸ retrieveByCode(codeCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
codeCopy to Clipboard | stringCopy to Clipboard |
configCopy to Clipboard | FindConfigCopy to Clipboard<GiftCardCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
Defined in
packages/medusa/src/services/gift-card.ts:256
retrieve_
▸ ProtectedCopy to Clipboard retrieve_(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
selectorCopy to Clipboard | SelectorCopy to Clipboard<GiftCardCopy to Clipboard> |
configCopy to Clipboard | FindConfigCopy to Clipboard<GiftCardCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
Defined in
packages/medusa/src/services/gift-card.ts:208
shouldRetryTransaction_
▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard
Parameters
| Name | Type |
|---|---|
errCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard } |
Returns
booleanCopy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(giftCardIdCopy to Clipboard, updateCopy to Clipboard): PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
Updates a giftCard.
Parameters
| Name | Type | Description |
|---|---|---|
giftCardIdCopy to Clipboard | stringCopy to Clipboard | giftCard id of giftCard to update |
updateCopy to Clipboard | UpdateGiftCardInputCopy to Clipboard | the data to update the giftCard with |
Returns
PromiseCopy to Clipboard<GiftCardCopy to Clipboard>
the result of the update operation
Defined in
packages/medusa/src/services/gift-card.ts:276
withTransaction
▸ withTransaction(transactionManager?Copy to Clipboard): GiftCardServiceCopy to Clipboard
Parameters
| Name | Type |
|---|---|
transactionManager?Copy to Clipboard | EntityManagerCopy to Clipboard |
Returns
GiftCardServiceCopy to Clipboard
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14
generateCode
▸ StaticCopy to Clipboard generateCode(): stringCopy to Clipboard
Generates a 16 character gift card code
Returns
stringCopy to Clipboard
the generated gift card code
Defined in
packages/medusa/src/services/gift-card.ts:69
resolveTaxRate
▸ StaticCopy to Clipboard ProtectedCopy to Clipboard resolveTaxRate(giftCardTaxRateCopy to Clipboard, regionCopy to Clipboard): nullCopy to Clipboard | numberCopy to Clipboard
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
| Name | Type |
|---|---|
giftCardTaxRateCopy to Clipboard | nullCopy to Clipboard | numberCopy to Clipboard |
regionCopy to Clipboard | RegionCopy to Clipboard |
Returns
nullCopy to Clipboard | numberCopy to Clipboard
the tax rate for the gift card