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

38
docs/content/references/js-client/classes/OrdersResource.md
View File

@@ -10,67 +10,73 @@
### lookupOrder
▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
**`description`** Look up an order using order details
**`Description`**
Look up an order using order details
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StoreGetOrdersParams`](internal.StoreGetOrdersParams.md) | details used to look up the order |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
| `payload` | [`StoreGetOrdersParams`](internal-35.StoreGetOrdersParams.md) | details used to look up the order |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
#### Defined in
[packages/medusa-js/src/resources/orders.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L35)
[medusa-js/src/resources/orders.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/orders.ts#L41)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
**`description`** Retrieves an order
**`Description`**
Retrieves an order
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
#### Defined in
[packages/medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L13)
[medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/orders.ts#L13)
___
### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
**`description`** Retrieves an order by cart id
**`Description`**
Retrieves an order by cart id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
#### Defined in
[packages/medusa-js/src/resources/orders.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L24)
[medusa-js/src/resources/orders.ts:27](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/orders.ts#L27)