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

docs: updated js client reference (#2414)

Browse Source 
* docs: updated js client reference

* docs: fixed link
This commit is contained in:
Shahed Nasser
2022-10-11 16:32:41 +03:00
committed by GitHub
parent b3ebc78b95
commit 8ca9354c50
384 changed files with 5705 additions and 4184 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/content/references/js-client/classes/AdminShippingOptionsResource.md
View File

@@ -10,7 +10,7 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\>
**`Description`**
@@ -20,18 +20,18 @@ creates a shipping option.
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostShippingOptionsReq`](internal-21.AdminPostShippingOptionsReq.md) |
| `payload` | [`AdminPostShippingOptionsReq`](internal-23.AdminPostShippingOptionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\>
created shipping option.
#### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/f7a63f178/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/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L20)
___
@@ -58,13 +58,13 @@ deleted response
#### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/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/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L50)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\>
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-23.md#adminshippingoptionslistres)\>
**`Description`**
@@ -74,24 +74,24 @@ lists shipping options matching a query
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetShippingOptionsParams`](internal-21.AdminGetShippingOptionsParams.md) | query for searching shipping options |
| `query?` | [`AdminGetShippingOptionsParams`](internal-23.AdminGetShippingOptionsParams.md) | query for searching shipping options |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-23.md#adminshippingoptionslistres)\>
a list of shipping options matching the query.
#### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-options.ts#L78)
[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L78)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\>
**`Description`**
@@ -106,19 +106,19 @@ get a shipping option
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\>
the shipping option with the given id
#### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-options.ts#L64)
[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L64)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\>
**`Description`**
@@ -129,15 +129,15 @@ updates a shipping option
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the shipping option to update. |
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-21.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-23.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\>
the updated shipping option.
#### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/f7a63f178/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/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L35)