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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/content/references/js-client/classes/AdminGiftCardsResource.md
View File

@@ -10,114 +10,124 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
**`description`** Creates a gift card
**`Description`**
Creates a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostGiftCardsReq`](internal.AdminPostGiftCardsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `payload` | [`AdminPostGiftCardsReq`](internal-8.AdminPostGiftCardsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
**`description`** Deletes a gift card
**`Description`**
Deletes a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L36)
[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L40)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\>
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.md#admingiftcardslistres)\>
**`description`** Lists gift cards
**`Description`**
Lists gift cards
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetGiftCardsParams`](internal.AdminGetGiftCardsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `query?` | [`AdminGetGiftCardsParams`](internal-8.AdminGetGiftCardsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.md#admingiftcardslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L52)
[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L62)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
**`description`** Deletes a gift card
**`Description`**
Deletes a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L44)
[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L51)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
**`description`** Updates a gift card
**`Description`**
Updates a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal.AdminPostGiftCardsGiftCardReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.AdminPostGiftCardsGiftCardReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L25)
[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L28)