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
docs/content/references/js-client/classes/SwapsResource.md
+7 -7
View File
@@ -10,7 +10,7 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
**`Description`**
@@ -20,22 +20,22 @@ Creates a swap from a cart
| Name | Type |
| :------ | :------ |
| `payload` | [`StorePostSwapsReq`](internal-43.StorePostSwapsReq.md) |
| `payload` | [`StorePostSwapsReq`](internal-46.StorePostSwapsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
#### Defined in
[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/swaps.ts#L12)
[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/swaps.ts#L12)
___
### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
**`Description`**
@@ -50,8 +50,8 @@ Retrieves a swap by cart id
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\>
#### Defined in
[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/swaps.ts#L23)
[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/swaps.ts#L23)