Class GiftCards

Hierarchy

Base
- GiftCards

Index

Constructors

Methods

processGiftCardActivate processGiftCardBalance processGiftCardDeactivate processGiftCardLoad processGiftCardRefund processGiftCardSale request

Constructors

constructor

new GiftCards(config): GiftCards
Constructor function for the Config class.
Parameters
- config: Config
  
  The configuration options for the class.
Returns GiftCards
Inherited from Base.constructor
- Defined in base.ts:22

Methods

processGiftCardActivate

processGiftCardActivate(req): Promise<GiftCardActivateResponse>
Activate and load a new Gift Card.
Parameters
- req: GiftCardActivate
  
  The gift card activate and load balance object.
Returns Promise<GiftCardActivateResponse>
- A promise that resolves to the gift card activate and load request.
- Defined in resources/gift-cards.ts:107

processGiftCardBalance

processGiftCardBalance(req): Promise<GiftCardBalanceResponse>
Check gift card balance.
Parameters
- req: GiftCardBalance
  
  The gift card balance object.
Returns Promise<GiftCardBalanceResponse>
- A promise that resolves to the gift card balance request.
- Defined in resources/gift-cards.ts:26

processGiftCardDeactivate

processGiftCardDeactivate(req): Promise<GiftCardDeactivateResponse>
Deactivate a Gift Card. This should be done when a card is lost, stolen or demagnetized in order to stop unauthorized use
Parameters
- req: GiftCardDeactivate
  
  The gift card load balance object.
Returns Promise<GiftCardDeactivateResponse>
- A promise that resolves to the gift card load request.
- Defined in resources/gift-cards.ts:129

processGiftCardLoad

processGiftCardLoad(req): Promise<GiftCardLoadResponse>
Load a new or reload an existing Gift Card.
Parameters
- req: GiftCardLoad
  
  The gift card load balance object.
Returns Promise<GiftCardLoadResponse>
- A promise that resolves to the gift card load request.
- Defined in resources/gift-cards.ts:87

processGiftCardRefund

processGiftCardRefund(req): Promise<GiftCardRefundResponse>
Refund a Gift Card transaction
Parameters
- req: GiftCardRefund
  
  The gift card refund transaction object.
Returns Promise<GiftCardRefundResponse>
- A promise that resolves to the gift card refund transaction request.
- Defined in resources/gift-cards.ts:150

processGiftCardSale

processGiftCardSale(req): Promise<GiftCardProcessSaleResponse>
Process a gift card sale.
Parameters
- req: GiftCardProcessSale
  
  The gift card sale object.
Returns Promise<GiftCardProcessSaleResponse>
- A promise that resolves to the gift card sale request.
- Defined in resources/gift-cards.ts:47

`Protected` request

request<T>(endpoint, queryParams?, options?): Promise<T>
Sends a request to the specified endpoint with optional query parameters and options.
Type Parameters
- T
Parameters
- endpoint: string
  
  The endpoint to send the request to.
- Optional queryParams: Record<string, any>
  
  Optional query parameters for the request.
- Optional options: RequestInit
  
  Optional additional options for the request.
Returns Promise<T>
A promise that resolves to the response data.
Inherited from Base.request
- Defined in base.ts:37

Class GiftCards

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: Config

Returns GiftCards

Methods

processGiftCardActivate

Parameters

req: GiftCardActivate

Returns Promise<GiftCardActivateResponse>

processGiftCardBalance

Parameters

req: GiftCardBalance

Returns Promise<GiftCardBalanceResponse>

processGiftCardDeactivate

Parameters

req: GiftCardDeactivate

Returns Promise<GiftCardDeactivateResponse>

processGiftCardLoad

Parameters

req: GiftCardLoad

Returns Promise<GiftCardLoadResponse>

processGiftCardRefund

Parameters

req: GiftCardRefund

Returns Promise<GiftCardRefundResponse>

processGiftCardSale

Parameters

req: GiftCardProcessSale

Returns Promise<GiftCardProcessSaleResponse>

Protected request

Type Parameters

T

Parameters

endpoint: string

Optional queryParams: Record<string, any>

Optional options: RequestInit

Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

`Protected` request

`Optional` queryParams: Record<string, any>

`Optional` options: RequestInit