chore(docs): Generated Services Reference (automated) (#3719)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
3838067a54
commit
198f39f8d4
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:96](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L96)
|
||||
[medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L92)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L82)
|
||||
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L92)
|
||||
[medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L83)
|
||||
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L88)
|
||||
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L91)
|
||||
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L87)
|
||||
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,13 +136,13 @@ ___
|
||||
|
||||
• `Protected` **manager\_**: `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L77)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +152,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L84)
|
||||
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +162,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L90)
|
||||
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -172,7 +172,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L94)
|
||||
[medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L85)
|
||||
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
@@ -192,17 +192,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L89)
|
||||
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
### swapRepository\_
|
||||
|
||||
• `Protected` `Readonly` **swapRepository\_**: typeof `SwapRepository`
|
||||
• `Protected` `Readonly` **swapRepository\_**: `Repository`<`Swap`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L80)
|
||||
[medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -212,7 +212,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L86)
|
||||
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
@@ -220,13 +220,13 @@ ___
|
||||
|
||||
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L78)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -250,7 +250,25 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L65)
|
||||
[medusa/src/services/swap.ts:64](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L64)
|
||||
|
||||
## Accessors
|
||||
|
||||
### activeManager\_
|
||||
|
||||
• `Protected` `get` **activeManager_**(): `EntityManager`
|
||||
|
||||
#### Returns
|
||||
|
||||
`EntityManager`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.activeManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -270,7 +288,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1226](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1226)
|
||||
[medusa/src/services/swap.ts:1219](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1219)
|
||||
|
||||
___
|
||||
|
||||
@@ -309,7 +327,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -335,7 +353,7 @@ the canceled swap.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:842](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L842)
|
||||
[medusa/src/services/swap.ts:837](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L837)
|
||||
|
||||
___
|
||||
|
||||
@@ -359,7 +377,7 @@ updated swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1043](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1043)
|
||||
[medusa/src/services/swap.ts:1038](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1038)
|
||||
|
||||
___
|
||||
|
||||
@@ -383,6 +401,7 @@ and an optional return shipping method.
|
||||
| `custom` | `Object` | contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order |
|
||||
| `custom.allow_backorder?` | `boolean` | - |
|
||||
| `custom.idempotency_key?` | `string` | - |
|
||||
| `custom.location_id?` | `string` | - |
|
||||
| `custom.no_notification?` | `boolean` | - |
|
||||
|
||||
#### Returns
|
||||
@@ -393,7 +412,7 @@ the newly created swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:317](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L317)
|
||||
[medusa/src/services/swap.ts:302](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L302)
|
||||
|
||||
___
|
||||
|
||||
@@ -421,7 +440,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/a4575c391/packages/medusa/src/services/swap.ts#L571)
|
||||
[medusa/src/services/swap.ts:558](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L558)
|
||||
|
||||
___
|
||||
|
||||
@@ -447,7 +466,7 @@ the updated swap with new status and fulfillments.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:904](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L904)
|
||||
[medusa/src/services/swap.ts:899](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L899)
|
||||
|
||||
___
|
||||
|
||||
@@ -474,7 +493,7 @@ the updated swap with new fulfillments and status.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1074](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1074)
|
||||
[medusa/src/services/swap.ts:1069](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1069)
|
||||
|
||||
___
|
||||
|
||||
@@ -499,7 +518,7 @@ resolves to the updated result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1152](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1152)
|
||||
[medusa/src/services/swap.ts:1147](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1147)
|
||||
|
||||
___
|
||||
|
||||
@@ -524,7 +543,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:287](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L287)
|
||||
[medusa/src/services/swap.ts:274](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L274)
|
||||
|
||||
___
|
||||
|
||||
@@ -548,7 +567,7 @@ processed swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:415](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L415)
|
||||
[medusa/src/services/swap.ts:402](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L402)
|
||||
|
||||
___
|
||||
|
||||
@@ -572,7 +591,7 @@ swap related to the cart
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:709](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L709)
|
||||
[medusa/src/services/swap.ts:704](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L704)
|
||||
|
||||
___
|
||||
|
||||
@@ -597,7 +616,7 @@ the resulting order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1192](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1192)
|
||||
[medusa/src/services/swap.ts:1185](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1185)
|
||||
|
||||
___
|
||||
|
||||
@@ -622,7 +641,7 @@ the swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:211](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L211)
|
||||
[medusa/src/services/swap.ts:204](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L204)
|
||||
|
||||
___
|
||||
|
||||
@@ -647,7 +666,7 @@ the swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:260](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L260)
|
||||
[medusa/src/services/swap.ts:247](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L247)
|
||||
|
||||
___
|
||||
|
||||
@@ -671,7 +690,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -695,7 +714,7 @@ transformed find swap config
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:138](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L138)
|
||||
[medusa/src/services/swap.ts:131](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
@@ -720,7 +739,7 @@ updated swap record
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:538](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L538)
|
||||
[medusa/src/services/swap.ts:525](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L525)
|
||||
|
||||
___
|
||||
|
||||
@@ -744,4 +763,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
|
||||
Reference in New Issue
Block a user