chore(docs): Generated Services Reference (automated) (#4560)
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]
committed by
GitHub
GitHub
parent
e8b27b0cde
commit
6ee80794c9
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L91)
|
||||
[medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/95c538c67/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/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/95c538c67/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/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/95c538c67/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/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L77)
|
||||
[medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L87)
|
||||
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L78)
|
||||
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L83)
|
||||
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L86)
|
||||
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L82)
|
||||
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/95c538c67/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/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +152,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L79)
|
||||
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +162,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L85)
|
||||
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -172,7 +172,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L89)
|
||||
[medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L80)
|
||||
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
@@ -192,7 +192,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L84)
|
||||
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -202,7 +202,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L75)
|
||||
[medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
@@ -212,7 +212,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L81)
|
||||
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/95c538c67/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/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -250,7 +250,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L63)
|
||||
[medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/95c538c67/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/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -288,7 +288,7 @@ TransactionBaseService.activeManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1225](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L1225)
|
||||
[medusa/src/services/swap.ts:1245](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L1245)
|
||||
|
||||
___
|
||||
|
||||
@@ -327,7 +327,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -353,7 +353,7 @@ the canceled swap.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:840](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L840)
|
||||
[medusa/src/services/swap.ts:860](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L860)
|
||||
|
||||
___
|
||||
|
||||
@@ -377,7 +377,7 @@ updated swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1044](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L1044)
|
||||
[medusa/src/services/swap.ts:1064](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L1064)
|
||||
|
||||
___
|
||||
|
||||
@@ -412,7 +412,7 @@ the newly created swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:301](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L301)
|
||||
[medusa/src/services/swap.ts:321](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L321)
|
||||
|
||||
___
|
||||
|
||||
@@ -442,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:557](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L557)
|
||||
[medusa/src/services/swap.ts:577](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L577)
|
||||
|
||||
___
|
||||
|
||||
@@ -468,7 +468,7 @@ the updated swap with new status and fulfillments.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:902](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L902)
|
||||
[medusa/src/services/swap.ts:922](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L922)
|
||||
|
||||
___
|
||||
|
||||
@@ -495,7 +495,7 @@ the updated swap with new fulfillments and status.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1075](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L1075)
|
||||
[medusa/src/services/swap.ts:1095](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L1095)
|
||||
|
||||
___
|
||||
|
||||
@@ -520,7 +520,7 @@ resolves to the updated result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1153](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L1153)
|
||||
[medusa/src/services/swap.ts:1173](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L1173)
|
||||
|
||||
___
|
||||
|
||||
@@ -545,7 +545,32 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:273](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L273)
|
||||
[medusa/src/services/swap.ts:273](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L273)
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Swap`[], `number`]\>
|
||||
|
||||
List swaps.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `selector` | `Selector`<`Swap`\> | the query object for find |
|
||||
| `config` | `FindConfig`<`Swap`\> | the configuration used to find the objects. contains relations, skip, and take. |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`Swap`[], `number`]\>
|
||||
|
||||
the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:293](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L293)
|
||||
|
||||
___
|
||||
|
||||
@@ -569,7 +594,7 @@ processed swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:401](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L401)
|
||||
[medusa/src/services/swap.ts:421](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L421)
|
||||
|
||||
___
|
||||
|
||||
@@ -593,7 +618,7 @@ swap related to the cart
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:707](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L707)
|
||||
[medusa/src/services/swap.ts:727](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L727)
|
||||
|
||||
___
|
||||
|
||||
@@ -618,7 +643,7 @@ the resulting order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:1191](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L1191)
|
||||
[medusa/src/services/swap.ts:1211](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L1211)
|
||||
|
||||
___
|
||||
|
||||
@@ -643,7 +668,7 @@ the swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:203](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L203)
|
||||
[medusa/src/services/swap.ts:203](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L203)
|
||||
|
||||
___
|
||||
|
||||
@@ -668,7 +693,7 @@ the swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:246](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L246)
|
||||
[medusa/src/services/swap.ts:246](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L246)
|
||||
|
||||
___
|
||||
|
||||
@@ -692,7 +717,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -716,7 +741,7 @@ transformed find swap config
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:130](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L130)
|
||||
[medusa/src/services/swap.ts:130](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
@@ -741,7 +766,7 @@ updated swap record
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/swap.ts:524](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/swap.ts#L524)
|
||||
[medusa/src/services/swap.ts:544](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/swap.ts#L544)
|
||||
|
||||
___
|
||||
|
||||
@@ -765,4 +790,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
|
||||
Reference in New Issue
Block a user