Class GiftCards

Issue and read gift cards (scopes: balances:read to read, payments:write to issue).

Index

Constructors

Methods

create get list templates

Constructors

constructor

new GiftCards(c: Requester): GiftCards
Parameters
- c: Requester
Returns GiftCards
- Defined in src/resources/giftcards.ts:21

Methods

create

create(
params: CreateGiftCardParams,
opts?: IdempotencyOptions,
): Promise<Record<string, unknown>>
Issue a new gift card, debiting its face value from your balance (scope: payments:write).
Parameters
- params: CreateGiftCardParams
  The card to issue; see CreateGiftCardParams.
- opts: IdempotencyOptions = {}
  Optional { idempotencyKey } — retrying with the same key + body replays the original.
Returns Promise<Record<string, unknown>>
The created gift-card record.

Throws
On failure (e.g. 401/403 missing payments:write, 422 insufficient balance, 404 unknown template).
- Defined in src/resources/giftcards.ts:61

get

get(cardNum: string): Promise<Record<string, unknown>>
Fetch a single gift card by its card number (scope: balances:read).
Parameters
- cardNum: string
  The gift card's number.
Returns Promise<Record<string, unknown>>
The gift-card record.

Throws
On failure (e.g. 404 unknown card).
- Defined in src/resources/giftcards.ts:50

list

list(
query?: PageQuery & { q?: string; status?: GiftCardStatus },
): Promise<Page<Record<string, unknown>>>
List issued gift cards (scope: balances:read). Keyset-paginated.
Parameters
- query: PageQuery & { q?: string; status?: GiftCardStatus } = {}
  Filters + pagination; pass a prior page's nextCursor as before.
  - Optionalq?: string
    Optional free-text search.
  - Optionalstatus?: GiftCardStatus
    Optional GiftCardStatus filter.
Returns Promise<Page<Record<string, unknown>>>
The raw { items, nextCursor } page of gift-card records.

Throws
On failure (e.g. 401/403 missing balances:read).
- Defined in src/resources/giftcards.ts:40

templates

templates(): Promise<Page<Record<string, unknown>>>
List the available gift-card design templates (scope: balances:read).

Returns Promise<Page<Record<string, unknown>>>
The raw { items, nextCursor } (nextCursor always null) of template records.

Throws
On failure (e.g. 401/403 missing balances:read).
- Defined in src/resources/giftcards.ts:28