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

26
docs/content/references/js-client/classes/ShippingOptionsResource.md
View File

@@ -10,44 +10,48 @@
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
**`description`** Lists shiping options available
**`Description`**
Lists shiping options available
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`StoreGetShippingOptionsParams`](internal.StoreGetShippingOptionsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `query?` | [`StoreGetShippingOptionsParams`](internal-42.StoreGetShippingOptionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
#### Defined in
[packages/medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L27)
[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/shipping-options.ts#L27)
___
### listCartOptions
▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
**`description`** Lists shiping options available for a cart
**`Description`**
Lists shiping options available for a cart
#### Parameters
| Name | Type |
| :------ | :------ |
| `cart_id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
#### Defined in
[packages/medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L16)
[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/shipping-options.ts#L16)