Skip to main content

Class: AdminGiftCardsResource

Hierarchy

  • default

    AdminGiftCardsResource

Methods

create

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

Description

Creates a gift card

Parameters

NameType
payloadAdminPostGiftCardsReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminGiftCardsRes>

Defined in

medusa-js/src/resources/admin/gift-cards.ts:17


delete

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

Description

Deletes a gift card

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

medusa-js/src/resources/admin/gift-cards.ts:40


list

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

Description

Lists gift cards

Parameters

NameType
query?AdminGetGiftCardsParams
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminGiftCardsListRes>

Defined in

medusa-js/src/resources/admin/gift-cards.ts:62


retrieve

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

Description

Deletes a gift card

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminGiftCardsRes>

Defined in

medusa-js/src/resources/admin/gift-cards.ts:51


update

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

Description

Updates a gift card

Parameters

NameType
idstring
payloadAdminPostGiftCardsGiftCardReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminGiftCardsRes>

Defined in

medusa-js/src/resources/admin/gift-cards.ts:28

Was this page helpful?