daea35fe73
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
4.0 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Class: AdminGiftCardsResource
Hierarchy
-
default↳
AdminGiftCardsResource
Methods
create
▸ create(payload, customHeaders?): ResponsePromise<AdminGiftCardsRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostGiftCardsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminGiftCardsRes>
Description
Creates a gift card
Defined in
packages/medusa-js/src/resources/admin/gift-cards.ts:17
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Description
Deletes a gift card
Defined in
packages/medusa-js/src/resources/admin/gift-cards.ts:40
list
▸ list(query?, customHeaders?): ResponsePromise<AdminGiftCardsListRes>
Parameters
| Name | Type |
|---|---|
query? |
AdminGetGiftCardsParams |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminGiftCardsListRes>
Description
Lists gift cards
Defined in
packages/medusa-js/src/resources/admin/gift-cards.ts:62
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminGiftCardsRes>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminGiftCardsRes>
Description
Deletes a gift card
Defined in
packages/medusa-js/src/resources/admin/gift-cards.ts:51
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminGiftCardsRes>
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostGiftCardsGiftCardReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminGiftCardsRes>
Description
Updates a gift card