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

chore(docs): Generated JS Client Reference (#5334)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
www/apps/docs/content/references/js-client/classes/SwapsResource.md
View File

@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: SwapsResource
## Hierarchy
@@ -10,48 +14,48 @@
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\>
**`Description`**
Creates a swap from a cart
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`StorePostSwapsReq`](internal-51.StorePostSwapsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
| `payload` | [`StorePostSwapsReq`](internal-8.internal.StorePostSwapsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\>
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
**`Description`**
Creates a swap from a cart
#### Defined in
[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/swaps.ts#L12)
[packages/medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/swaps.ts#L12)
___
### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\>
**`Description`**
Retrieves a swap by cart id
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | id of cart |
| `customHeaders` | `Record`<`string`, `any`\> | |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\>
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
**`Description`**
Retrieves a swap by cart id
#### Defined in
[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/swaps.ts#L23)
[packages/medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/swaps.ts#L23)