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

chore(docs): Generated JS Client Reference (automated) (#2576)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-10 10:35:17 +02:00
committed by GitHub
parent dda886a77f
commit 557352cdfe
90 changed files with 684 additions and 549 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content/references/js-client/classes/SwapsResource.md
View File

@@ -10,7 +10,7 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-47.md#storeswapsres)\>
**`Description`**
@@ -20,22 +20,22 @@ Creates a swap from a cart
| Name | Type |
| :------ | :------ |
| `payload` | [`StorePostSwapsReq`](internal-46.StorePostSwapsReq.md) |
| `payload` | [`StorePostSwapsReq`](internal-47.StorePostSwapsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-47.md#storeswapsres)\>
#### Defined in
[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/resources/swaps.ts#L12)
[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/swaps.ts#L12)
___
### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-47.md#storeswapsres)\>
**`Description`**
@@ -50,8 +50,8 @@ Retrieves a swap by cart id
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-47.md#storeswapsres)\>
#### Defined in
[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/resources/swaps.ts#L23)
[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/swaps.ts#L23)