Class: AdminGiftCardsResource
Hierarchy
default
Copy to Clipboard↳
AdminGiftCardsResource
Copy to Clipboard
Methods
create
▸ create(payload
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminGiftCardsRes
Copy to Clipboard>
Description
Copy to Clipboard
Creates a gift card
Parameters
Name | Type |
---|---|
payload Copy to Clipboard | AdminPostGiftCardsReq Copy to Clipboard |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminGiftCardsRes
Copy to Clipboard>
Defined in
medusa-js/src/resources/admin/gift-cards.ts:17
delete
▸ delete(id
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<DeleteResponse
Copy to Clipboard>
Description
Copy to Clipboard
Deletes a gift card
Parameters
Name | Type |
---|---|
id Copy to Clipboard | string Copy to Clipboard |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<DeleteResponse
Copy to Clipboard>
Defined in
medusa-js/src/resources/admin/gift-cards.ts:40
list
▸ list(query?
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminGiftCardsListRes
Copy to Clipboard>
Description
Copy to Clipboard
Lists gift cards
Parameters
Name | Type |
---|---|
query? Copy to Clipboard | AdminGetGiftCardsParams Copy to Clipboard |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminGiftCardsListRes
Copy to Clipboard>
Defined in
medusa-js/src/resources/admin/gift-cards.ts:62
retrieve
▸ retrieve(id
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminGiftCardsRes
Copy to Clipboard>
Description
Copy to Clipboard
Deletes a gift card
Parameters
Name | Type |
---|---|
id Copy to Clipboard | string Copy to Clipboard |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminGiftCardsRes
Copy to Clipboard>
Defined in
medusa-js/src/resources/admin/gift-cards.ts:51
update
▸ update(id
Copy to Clipboard, payload
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminGiftCardsRes
Copy to Clipboard>
Description
Copy to Clipboard
Updates a gift card
Parameters
Name | Type |
---|---|
id Copy to Clipboard | string Copy to Clipboard |
payload Copy to Clipboard | AdminPostGiftCardsGiftCardReq Copy to Clipboard |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminGiftCardsRes
Copy to Clipboard>