medusa-store/docs/content/references/services/classes/GiftCardService.md

Class: GiftCardService

Hierarchy

• TransactionBaseService<GiftCardService>

  ↳ GiftCardService

Constructors

constructor

• new GiftCardService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService<GiftCardService&gt;.constructor

Defined in

services/gift-card.ts:46

Properties

configModule

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

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

services/gift-card.ts:37

---

giftCardRepository_

• Protected Readonly giftCardRepository_: typeof GiftCardRepository

Defined in

services/gift-card.ts:34

---

giftCardTransactionRepo_

• Protected Readonly giftCardTransactionRepo_: typeof GiftCardTransactionRepository

Defined in

services/gift-card.ts:35

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/gift-card.ts:39

---

regionService_

• Protected Readonly regionService_: RegionService

Defined in

services/gift-card.ts:36

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/gift-card.ts:40

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CREATED	string

Defined in

services/gift-card.ts:42

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

create

▸ create(giftCard): Promise<GiftCard>

Parameters

Name	Type	Description
giftCard	CreateGiftCardInput

Returns

Promise<GiftCard>

Defined in

services/gift-card.ts:155

---

createTransaction

▸ createTransaction(data): Promise<string>

Parameters

Name	Type
data	CreateGiftCardTransactionInput

Returns

Promise<string>

Defined in

services/gift-card.ts:139

---

delete

▸ delete(giftCardId): Promise<void | GiftCard>

Parameters

Name	Type	Description
giftCardId	string

Returns

Promise<void | GiftCard>

Defined in

services/gift-card.ts:288

---

list

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

Parameters

Name	Type	Description
selector	QuerySelector<GiftCard>
config	FindConfig<GiftCard>

Returns

Promise<GiftCard[]>

Defined in

services/gift-card.ts:114

---

listAndCount

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

Parameters

Name	Type	Description
selector	QuerySelector<GiftCard>
config	FindConfig<GiftCard>

Returns

Promise<[GiftCard[], number]>

Defined in

services/gift-card.ts:84

---

retrieve

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

Parameters

Name	Type	Description
giftCardId	string
config	FindConfig<GiftCard>

Returns

Promise<GiftCard>

Defined in

services/gift-card.ts:220

---

retrieveByCode

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

Parameters

Name	Type
code	string
config	FindConfig<GiftCard>

Returns

Promise<GiftCard>

Defined in

services/gift-card.ts:229

---

retrieve_

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

Parameters

Name	Type
selector	Selector<GiftCard>
config	FindConfig<GiftCard>

Returns

Promise<GiftCard>

Defined in

services/gift-card.ts:185

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

update

▸ update(giftCardId, update): Promise<GiftCard>

Parameters

Name	Type	Description
giftCardId	string
update	UpdateGiftCardInput

Returns

Promise<GiftCard>

Defined in

services/gift-card.ts:244

---

withTransaction

▸ withTransaction(transactionManager?): GiftCardService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

GiftCardService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16

---

generateCode

▸ Static generateCode(): string

Returns

string

Defined in

services/gift-card.ts:68