AdminGiftCardsResource

admin/gift-cards.AdminGiftCardsResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminGiftCardsRes>

Parameters

payloadAdminPostGiftCardsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminGiftCardsRes>

ResponsePromiseResponsePromise<AdminGiftCardsRes>Required

Description

Creates a gift card

---

delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

Description

Deletes a gift card

---

list

list(query?, customHeaders?): ResponsePromise<AdminGiftCardsListRes>

Parameters

queryAdminGetGiftCardsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminGiftCardsListRes>

ResponsePromiseResponsePromise<AdminGiftCardsListRes>Required

Description

Lists gift cards

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminGiftCardsRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminGiftCardsRes>

ResponsePromiseResponsePromise<AdminGiftCardsRes>Required

Description

Deletes a gift card

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminGiftCardsRes>

Parameters

idstringRequired

payloadAdminPostGiftCardsGiftCardReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminGiftCardsRes>

ResponsePromiseResponsePromise<AdminGiftCardsRes>Required

Description

Updates a gift card