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

chore(docs): Generated Services Reference (automated) (#4015)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-05-04 12:37:29 +03:00
committed by GitHub
co-authored by olivermrbl Shahed Nasser
parent cb66cd2a06
commit 2394c533d3
58 changed files with 1541 additions and 1517 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/services/classes/SwapService.md
+43 -41
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L92)
[medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L91)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
@@ -78,7 +78,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L78)
[medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L77)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L88)
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L87)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L79)
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L78)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L84)
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L83)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L87)
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L86)
___
@@ -128,7 +128,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L83)
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L82)
___
@@ -142,7 +142,7 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
@@ -152,7 +152,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L80)
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L79)
___
@@ -162,7 +162,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L86)
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L85)
___
@@ -172,7 +172,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L90)
[medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L89)
___
@@ -182,7 +182,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L81)
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L80)
___
@@ -192,7 +192,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L85)
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L84)
___
@@ -202,7 +202,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L76)
[medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L75)
___
@@ -212,7 +212,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L82)
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L81)
___
@@ -226,7 +226,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
@@ -250,7 +250,7 @@ ___
#### Defined in
[medusa/src/services/swap.ts:64](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L64)
[medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L63)
## Accessors
@@ -268,7 +268,7 @@ TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
@@ -288,7 +288,7 @@ TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/services/swap.ts:1221](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L1221)
[medusa/src/services/swap.ts:1223](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L1223)
___
@@ -327,7 +327,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
@@ -353,7 +353,7 @@ the canceled swap.
#### Defined in
[medusa/src/services/swap.ts:837](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L837)
[medusa/src/services/swap.ts:839](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L839)
___
@@ -377,7 +377,7 @@ updated swap
#### Defined in
[medusa/src/services/swap.ts:1040](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L1040)
[medusa/src/services/swap.ts:1042](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L1042)
___
@@ -412,13 +412,13 @@ the newly created swap
#### Defined in
[medusa/src/services/swap.ts:302](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L302)
[medusa/src/services/swap.ts:301](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L301)
___
### createCart
▸ **createCart**(`swapId`, `customShippingOptions?`): `Promise`<`Swap`\>
▸ **createCart**(`swapId`, `customShippingOptions?`, `context?`): `Promise`<`Swap`\>
Creates a cart from the given swap. The cart can be used to pay
for differences associated with the swap. The swap represented by the
@@ -431,6 +431,8 @@ swap.
| :------ | :------ | :------ | :------ |
| `swapId` | `string` | `undefined` | the id of the swap to create the cart from |
| `customShippingOptions` | { `option_id`: `string` ; `price`: `number` }[] | `[]` | the shipping options |
| `context` | `Object` | `{}` | - |
| `context.sales_channel_id?` | `string` | `undefined` | - |
#### Returns
@@ -440,7 +442,7 @@ the swap with its cart_id prop set to the id of the new cart.
#### Defined in
[medusa/src/services/swap.ts:558](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L558)
[medusa/src/services/swap.ts:557](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L557)
___
@@ -466,7 +468,7 @@ the updated swap with new status and fulfillments.
#### Defined in
[medusa/src/services/swap.ts:899](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L899)
[medusa/src/services/swap.ts:901](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L901)
___
@@ -493,7 +495,7 @@ the updated swap with new fulfillments and status.
#### Defined in
[medusa/src/services/swap.ts:1071](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L1071)
[medusa/src/services/swap.ts:1073](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L1073)
___
@@ -518,7 +520,7 @@ resolves to the updated result.
#### Defined in
[medusa/src/services/swap.ts:1149](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L1149)
[medusa/src/services/swap.ts:1151](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L1151)
___
@@ -543,7 +545,7 @@ the result of the find operation
#### Defined in
[medusa/src/services/swap.ts:274](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L274)
[medusa/src/services/swap.ts:273](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L273)
___
@@ -567,7 +569,7 @@ processed swap
#### Defined in
[medusa/src/services/swap.ts:402](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L402)
[medusa/src/services/swap.ts:401](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L401)
___
@@ -591,7 +593,7 @@ swap related to the cart
#### Defined in
[medusa/src/services/swap.ts:704](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L704)
[medusa/src/services/swap.ts:706](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L706)
___
@@ -616,7 +618,7 @@ the resulting order
#### Defined in
[medusa/src/services/swap.ts:1187](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L1187)
[medusa/src/services/swap.ts:1189](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L1189)
___
@@ -641,7 +643,7 @@ the swap
#### Defined in
[medusa/src/services/swap.ts:204](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L204)
[medusa/src/services/swap.ts:203](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L203)
___
@@ -666,7 +668,7 @@ the swap
#### Defined in
[medusa/src/services/swap.ts:247](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L247)
[medusa/src/services/swap.ts:246](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L246)
___
@@ -690,7 +692,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
@@ -714,7 +716,7 @@ transformed find swap config
#### Defined in
[medusa/src/services/swap.ts:131](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L131)
[medusa/src/services/swap.ts:130](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L130)
___
@@ -739,7 +741,7 @@ updated swap record
#### Defined in
[medusa/src/services/swap.ts:525](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/services/swap.ts#L525)
[medusa/src/services/swap.ts:524](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/services/swap.ts#L524)
___
@@ -763,4 +765,4 @@ TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b41b6303c/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/731f05d3e/packages/medusa/src/interfaces/transaction-base-service.ts#L20)