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/AdminShippingOptionsResource.md
View File

@@ -10,124 +10,134 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
**`description`** creates a shipping option.
**`Description`**
creates a shipping option.
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostShippingOptionsReq`](internal.AdminPostShippingOptionsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `payload` | [`AdminPostShippingOptionsReq`](internal-21.AdminPostShippingOptionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
created shipping option.
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L20)
[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L20)
___
### 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 shipping option
**`Description`**
deletes a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of shipping option to delete. |
| `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)\>
deleted response
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L50)
[medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L50)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\>
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\>
**`description`** lists shipping options matching a query
**`Description`**
lists shipping options matching a query
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetShippingOptionsParams`](internal.AdminGetShippingOptionsParams.md) | query for searching shipping options |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
| `query?` | [`AdminGetShippingOptionsParams`](internal-21.AdminGetShippingOptionsParams.md) | query for searching shipping options |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\>
a list of shipping options matching the query.
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L72)
[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L78)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
**`description`** get a shipping option
**`Description`**
get a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the shipping option to retrieve. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
the shipping option with the given id
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L61)
[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L64)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
**`description`** updates a shipping option
**`Description`**
updates a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the shipping option to update. |
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-21.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
the updated shipping option.
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L35)
[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L35)