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

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

Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-03-13 18:29:42 +00:00
committed by GitHub
parent a5582b93b8
commit 9ceddf45a9
58 changed files with 1496 additions and 1463 deletions

View File

@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/swap.ts:96](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L96)
[packages/medusa/src/services/swap.ts:96](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L96)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
___
@@ -78,7 +78,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L82)
[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L82)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L92)
[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L92)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L83)
[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L83)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L88)
[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L88)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L91)
[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L91)
___
@@ -128,7 +128,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L87)
[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L87)
___
@@ -142,7 +142,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L77)
[packages/medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L77)
___
@@ -152,7 +152,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L84)
[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L84)
___
@@ -162,7 +162,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L90)
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L90)
___
@@ -172,7 +172,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L94)
[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L94)
___
@@ -182,7 +182,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L85)
[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L85)
___
@@ -192,7 +192,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L89)
[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L89)
___
@@ -202,7 +202,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L80)
[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L80)
___
@@ -212,7 +212,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L86)
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L86)
___
@@ -226,7 +226,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L78)
[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L78)
___
@@ -250,7 +250,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:65](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L65)
[packages/medusa/src/services/swap.ts:65](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L65)
## Methods
@@ -270,7 +270,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:1226](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L1226)
[packages/medusa/src/services/swap.ts:1226](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L1226)
___
@@ -309,7 +309,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -335,7 +335,7 @@ the canceled swap.
#### Defined in
[packages/medusa/src/services/swap.ts:842](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L842)
[packages/medusa/src/services/swap.ts:842](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L842)
___
@@ -359,7 +359,7 @@ updated swap
#### Defined in
[packages/medusa/src/services/swap.ts:1043](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L1043)
[packages/medusa/src/services/swap.ts:1043](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L1043)
___
@@ -393,7 +393,7 @@ the newly created swap
#### Defined in
[packages/medusa/src/services/swap.ts:317](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L317)
[packages/medusa/src/services/swap.ts:317](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L317)
___
@@ -421,7 +421,7 @@ the swap with its cart_id prop set to the id of the new cart.
#### Defined in
[packages/medusa/src/services/swap.ts:571](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L571)
[packages/medusa/src/services/swap.ts:571](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L571)
___
@@ -447,7 +447,7 @@ the updated swap with new status and fulfillments.
#### Defined in
[packages/medusa/src/services/swap.ts:904](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L904)
[packages/medusa/src/services/swap.ts:904](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L904)
___
@@ -474,7 +474,7 @@ the updated swap with new fulfillments and status.
#### Defined in
[packages/medusa/src/services/swap.ts:1074](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L1074)
[packages/medusa/src/services/swap.ts:1074](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L1074)
___
@@ -499,7 +499,7 @@ resolves to the updated result.
#### Defined in
[packages/medusa/src/services/swap.ts:1152](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L1152)
[packages/medusa/src/services/swap.ts:1152](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L1152)
___
@@ -524,7 +524,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/swap.ts:287](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L287)
[packages/medusa/src/services/swap.ts:287](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L287)
___
@@ -548,7 +548,7 @@ processed swap
#### Defined in
[packages/medusa/src/services/swap.ts:415](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L415)
[packages/medusa/src/services/swap.ts:415](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L415)
___
@@ -572,7 +572,7 @@ swap related to the cart
#### Defined in
[packages/medusa/src/services/swap.ts:709](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L709)
[packages/medusa/src/services/swap.ts:709](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L709)
___
@@ -597,7 +597,7 @@ the resulting order
#### Defined in
[packages/medusa/src/services/swap.ts:1192](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L1192)
[packages/medusa/src/services/swap.ts:1192](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L1192)
___
@@ -622,7 +622,7 @@ the swap
#### Defined in
[packages/medusa/src/services/swap.ts:211](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L211)
[packages/medusa/src/services/swap.ts:211](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L211)
___
@@ -647,7 +647,7 @@ the swap
#### Defined in
[packages/medusa/src/services/swap.ts:260](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L260)
[packages/medusa/src/services/swap.ts:260](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L260)
___
@@ -671,7 +671,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -695,7 +695,7 @@ transformed find swap config
#### Defined in
[packages/medusa/src/services/swap.ts:138](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L138)
[packages/medusa/src/services/swap.ts:138](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L138)
___
@@ -720,7 +720,7 @@ updated swap record
#### Defined in
[packages/medusa/src/services/swap.ts:538](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/services/swap.ts#L538)
[packages/medusa/src/services/swap.ts:538](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/services/swap.ts#L538)
___
@@ -744,4 +744,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/3718f88c6/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/77fd361ce/packages/medusa/src/interfaces/transaction-base-service.ts#L14)