asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated JS Client Reference (#5334)

Browse Source 
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>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md
+60 -56
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGiftCardsResource
## Hierarchy
@@ -10,124 +14,124 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostGiftCardsReq`](internal-8.internal.AdminPostGiftCardsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
**`Description`**
Creates a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostGiftCardsReq`](internal-9.AdminPostGiftCardsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
#### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
[packages/medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
**`Description`**
Deletes a gift card
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
Deletes a gift card
#### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L40)
[packages/medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L40)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\>
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.internal.md#admingiftcardslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetGiftCardsParams`](internal-8.internal.AdminGetGiftCardsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.internal.md#admingiftcardslistres)\>
**`Description`**
Lists gift cards
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetGiftCardsParams`](internal-9.AdminGetGiftCardsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\>
#### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L62)
[packages/medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L62)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
**`Description`**
Deletes a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
#### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L51)
[packages/medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L51)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
**`Description`**
Updates a gift card
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-9.AdminPostGiftCardsGiftCardReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.internal.AdminPostGiftCardsGiftCardReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
**`Description`**
Updates a gift card
#### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L28)
[packages/medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L28)