3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
3.8 KiB
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
packages/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
packages/medusa-js/src/resources/admin/gift-cards.ts:36
list
▸ list(query?, customHeaders?): ResponsePromise<AdminGiftCardsListRes>
description Lists gift cards
Parameters
| Name | Type |
|---|---|
query? |
AdminGetGiftCardsParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminGiftCardsListRes>
Defined in
packages/medusa-js/src/resources/admin/gift-cards.ts:52
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
packages/medusa-js/src/resources/admin/gift-cards.ts:44
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>