Class: AdminGiftCardsResource
Hierarchy
default↳
AdminGiftCardsResource
Methods
create
▸ create(payload, customHeaders?): ResponsePromise<AdminGiftCardsRes>
Description
Creates a gift card
Parameters
| Name | Type |
|---|---|
payload | AdminPostGiftCardsReq |
customHeaders | Record<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
| Name | Type |
|---|---|
id | string |
customHeaders | Record<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
| Name | Type |
|---|---|
query? | AdminGetGiftCardsParams |
customHeaders | Record<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
| Name | Type |
|---|---|
id | string |
customHeaders | Record<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
| Name | Type |
|---|---|
id | string |
payload | AdminPostGiftCardsGiftCardReq |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminGiftCardsRes>