Skip to main content

Class: AdminGiftCardsResource

Hierarchy

  • defaultCopy to Clipboard

    AdminGiftCardsResourceCopy to Clipboard

Methods

create

create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminGiftCardsResCopy to Clipboard>

DescriptionCopy to Clipboard

Creates a gift card

Parameters

NameType
payloadCopy to ClipboardAdminPostGiftCardsReqCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminGiftCardsResCopy to Clipboard>

Defined in

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


delete

delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>

DescriptionCopy to Clipboard

Deletes a gift card

Parameters

NameType
idCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>

Defined in

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


list

list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminGiftCardsListResCopy to Clipboard>

DescriptionCopy to Clipboard

Lists gift cards

Parameters

NameType
query?Copy to ClipboardAdminGetGiftCardsParamsCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminGiftCardsListResCopy to Clipboard>

Defined in

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


retrieve

retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminGiftCardsResCopy to Clipboard>

DescriptionCopy to Clipboard

Deletes a gift card

Parameters

NameType
idCopy to ClipboardstringCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminGiftCardsResCopy to Clipboard>

Defined in

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


update

update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminGiftCardsResCopy to Clipboard>

DescriptionCopy to Clipboard

Updates a gift card

Parameters

NameType
idCopy to ClipboardstringCopy to Clipboard
payloadCopy to ClipboardAdminPostGiftCardsGiftCardReqCopy to Clipboard
customHeadersCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard>

Returns

ResponsePromiseCopy to Clipboard<AdminGiftCardsResCopy to Clipboard>

Defined in

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