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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2022-10-10 19:31:16 +03:00
1 parent 35df4962f8
commit 23bf4eb192
50 files changed
+4049 -1221
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/content/references/services/classes/AuthService.md
+14 -14
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/auth.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L25)
[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L24)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/auth.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L23)
[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L22)
___
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L20)
[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L19)
___
@@ -92,7 +92,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L21)
[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L20)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L22)
[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L21)
## Methods
@@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -169,7 +169,7 @@ success: whether authentication succeeded
#### Defined in
[packages/medusa/src/services/auth.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L98)
[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L97)
___
@@ -195,7 +195,7 @@ success: whether authentication succeeded
#### Defined in
[packages/medusa/src/services/auth.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L55)
[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L54)
___
@@ -223,7 +223,7 @@ success: whether authentication succeeded
#### Defined in
[packages/medusa/src/services/auth.ts:147](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L147)
[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L146)
___
@@ -248,7 +248,7 @@ the result of the comparison
#### Defined in
[packages/medusa/src/services/auth.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L39)
[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L38)
___
@@ -272,7 +272,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -296,4 +296,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/BatchJobService.md
+25 -25
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L93)
[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L93)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L41)
[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L41)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L45)
[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L45)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L42)
[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L42)
___
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L38)
[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L38)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L43)
[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L43)
___
@@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L39)
[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L39)
___
@@ -143,7 +143,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L27)
[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L27)
## Methods
@@ -182,7 +182,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -202,7 +202,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:274](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L274)
[packages/medusa/src/services/batch-job.ts:269](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L269)
___
@@ -222,7 +222,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:256](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L256)
[packages/medusa/src/services/batch-job.ts:251](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L251)
___
@@ -242,7 +242,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:238](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L238)
[packages/medusa/src/services/batch-job.ts:233](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L233)
___
@@ -262,7 +262,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:143](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L143)
[packages/medusa/src/services/batch-job.ts:138](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L138)
___
@@ -283,7 +283,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L132)
[packages/medusa/src/services/batch-job.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L127)
___
@@ -304,7 +304,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:371](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L371)
[packages/medusa/src/services/batch-job.ts:366](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L366)
___
@@ -325,7 +325,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:112](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L112)
[packages/medusa/src/services/batch-job.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L107)
___
@@ -346,7 +346,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:345](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L345)
[packages/medusa/src/services/batch-job.ts:340](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L340)
___
@@ -366,7 +366,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L292)
[packages/medusa/src/services/batch-job.ts:287](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L287)
___
@@ -386,7 +386,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:325](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L325)
[packages/medusa/src/services/batch-job.ts:320](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L320)
___
@@ -410,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -431,7 +431,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:162](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L162)
[packages/medusa/src/services/batch-job.ts:157](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L157)
___
@@ -452,7 +452,7 @@ ___
#### Defined in
[packages/medusa/src/services/batch-job.ts:203](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L203)
[packages/medusa/src/services/batch-job.ts:198](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L198)
___
@@ -476,4 +476,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/CartService.md
+155 -71
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L122)
[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L121)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L99)
[packages/medusa/src/services/cart.ts:98](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L98)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L98)
[packages/medusa/src/services/cart.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L97)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L117)
[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L116)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L110)
[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L109)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L112)
[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L111)
___
@@ -112,7 +112,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L102)
[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L101)
___
@@ -122,7 +122,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L120)
[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L119)
___
@@ -132,7 +132,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L113)
[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L112)
___
@@ -142,17 +142,17 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L116)
[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L115)
___
### lineItemAdjustmentService\_
• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService`
• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Defined in
[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L119)
[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L118)
___
@@ -162,7 +162,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L101)
[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L100)
___
@@ -172,7 +172,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L108)
[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L107)
___
@@ -186,7 +186,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/cart.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L94)
[packages/medusa/src/services/cart.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L93)
___
@@ -196,7 +196,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L109)
[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L108)
___
@@ -206,7 +206,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L100)
[packages/medusa/src/services/cart.ts:99](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L99)
___
@@ -216,7 +216,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L118)
[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L117)
___
@@ -226,7 +226,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L104)
[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L103)
___
@@ -236,7 +236,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L103)
[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L102)
___
@@ -246,7 +246,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L107)
[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L106)
___
@@ -256,7 +256,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L106)
[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L105)
___
@@ -266,7 +266,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L97)
[packages/medusa/src/services/cart.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L96)
___
@@ -276,7 +276,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L111)
[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L110)
___
@@ -286,7 +286,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L105)
[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L104)
___
@@ -296,7 +296,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L114)
[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L113)
___
@@ -306,7 +306,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L115)
[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L114)
___
@@ -320,7 +320,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/cart.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L95)
[packages/medusa/src/services/cart.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L94)
___
@@ -338,7 +338,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L88)
[packages/medusa/src/services/cart.ts:87](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L87)
## Methods
@@ -365,7 +365,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:614](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L614)
[packages/medusa/src/services/cart.ts:667](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L667)
___
@@ -395,7 +395,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1697](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1697)
[packages/medusa/src/services/cart.ts:1735](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1735)
___
@@ -423,7 +423,7 @@ void
#### Defined in
[packages/medusa/src/services/cart.ts:781](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L781)
[packages/medusa/src/services/cart.ts:834](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L834)
___
@@ -451,7 +451,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1207)
[packages/medusa/src/services/cart.ts:1260](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1260)
___
@@ -472,7 +472,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:1171](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1171)
[packages/medusa/src/services/cart.ts:1224](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1224)
___
@@ -511,7 +511,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -540,7 +540,7 @@ the resulting cart
#### Defined in
[packages/medusa/src/services/cart.ts:1353](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1353)
[packages/medusa/src/services/cart.ts:1406](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1406)
___
@@ -564,7 +564,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/cart.ts:351](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L351)
[packages/medusa/src/services/cart.ts:404](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L404)
___
@@ -588,7 +588,7 @@ the resultign customer object
#### Defined in
[packages/medusa/src/services/cart.ts:1056](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1056)
[packages/medusa/src/services/cart.ts:1109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1109)
___
@@ -608,7 +608,28 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:2105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2105)
[packages/medusa/src/services/cart.ts:2142](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2142)
___
### decorateTotals
▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<`Cart`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `cart` | `Cart` |
| `totalsConfig?` | `TotalsConfig` |
#### Returns
`Promise`<`Cart`\>
#### Defined in
[packages/medusa/src/services/cart.ts:2192](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2192)
___
@@ -630,7 +651,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:230](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L230)
[packages/medusa/src/services/cart.ts:247](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L247)
___
@@ -654,7 +675,7 @@ the deleted cart or undefined if the cart was not found.
#### Defined in
[packages/medusa/src/services/cart.ts:2018](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2018)
[packages/medusa/src/services/cart.ts:2057](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2057)
___
@@ -679,7 +700,7 @@ the resulting cart.
#### Defined in
[packages/medusa/src/services/cart.ts:1605](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1605)
[packages/medusa/src/services/cart.ts:1643](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1643)
___
@@ -699,7 +720,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:2136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2136)
[packages/medusa/src/services/cart.ts:2173](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2173)
___
@@ -725,7 +746,27 @@ custom shipping option
#### Defined in
[packages/medusa/src/services/cart.ts:1805](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1805)
[packages/medusa/src/services/cart.ts:1843](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1843)
___
### getTotalsRelations
▸ `Private` **getTotalsRelations**(`config`): `string`[]
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | `FindConfig`<`Cart`\> |
#### Returns
`string`[]
#### Defined in
[packages/medusa/src/services/cart.ts:178](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L178)
___
@@ -745,7 +786,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:454](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L454)
[packages/medusa/src/services/cart.ts:507](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L507)
___
@@ -768,7 +809,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/cart.ts:286](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L286)
[packages/medusa/src/services/cart.ts:303](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L303)
___
@@ -793,7 +834,7 @@ void
#### Defined in
[packages/medusa/src/services/cart.ts:1002](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1002)
[packages/medusa/src/services/cart.ts:1055](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1055)
___
@@ -813,7 +854,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:2155](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2155)
[packages/medusa/src/services/cart.ts:2263](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2263)
___
@@ -838,7 +879,7 @@ the resulting cart.
#### Defined in
[packages/medusa/src/services/cart.ts:1653](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1653)
[packages/medusa/src/services/cart.ts:1691](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1691)
___
@@ -863,7 +904,7 @@ the resulting cart
#### Defined in
[packages/medusa/src/services/cart.ts:1267](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1267)
[packages/medusa/src/services/cart.ts:1320](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1320)
___
@@ -888,7 +929,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:486](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L486)
[packages/medusa/src/services/cart.ts:539](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L539)
___
@@ -904,7 +945,7 @@ Gets a cart by id.
| :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to get. |
| `options` | `FindConfig`<`Cart`\> | the options to get a cart |
| `totalsConfig` | `TotalsConfig` | configuration for retrieval of totals |
| `totalsConfig` | `TotalsConfig` | - |
#### Returns
@@ -914,7 +955,50 @@ the cart document.
#### Defined in
[packages/medusa/src/services/cart.ts:304](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L304)
[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L320)
___
### retrieveNew
▸ `Private` **retrieveNew**(`cartId`, `options?`): `Promise`<`Cart`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `cartId` | `string` |
| `options` | `FindConfig`<`Cart`\> |
#### Returns
`Promise`<`Cart`\>
#### Defined in
[packages/medusa/src/services/cart.ts:356](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L356)
___
### retrieveWithTotals
▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`Cart`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `cartId` | `string` |
| `options` | `FindConfig`<`Cart`\> |
| `totalsConfig` | `TotalsConfig` |
#### Returns
`Promise`<`Cart`\>
#### Defined in
[packages/medusa/src/services/cart.ts:384](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L384)
___
@@ -942,7 +1026,7 @@ resolves to the updated result.
#### Defined in
[packages/medusa/src/services/cart.ts:2061](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2061)
[packages/medusa/src/services/cart.ts:2100](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2100)
___
@@ -967,7 +1051,7 @@ result of update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1424](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1424)
[packages/medusa/src/services/cart.ts:1477](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1477)
___
@@ -995,7 +1079,7 @@ the result of the update operation.
#### Defined in
[packages/medusa/src/services/cart.ts:1497](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1497)
[packages/medusa/src/services/cart.ts:1543](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1543)
___
@@ -1021,7 +1105,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1884](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1884)
[packages/medusa/src/services/cart.ts:1923](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1923)
___
@@ -1045,7 +1129,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -1065,7 +1149,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L179)
[packages/medusa/src/services/cart.ts:196](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L196)
___
@@ -1086,7 +1170,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:824](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L824)
[packages/medusa/src/services/cart.ts:877](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L877)
___
@@ -1112,7 +1196,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1082](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1082)
[packages/medusa/src/services/cart.ts:1135](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1135)
___
@@ -1137,7 +1221,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1038](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1038)
[packages/medusa/src/services/cart.ts:1091](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1091)
___
@@ -1163,7 +1247,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:716](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L716)
[packages/medusa/src/services/cart.ts:769](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L769)
___
@@ -1188,7 +1272,7 @@ the resulting cart
#### Defined in
[packages/medusa/src/services/cart.ts:1315](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1315)
[packages/medusa/src/services/cart.ts:1368](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1368)
___
@@ -1214,7 +1298,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/cart.ts:1122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1122)
[packages/medusa/src/services/cart.ts:1175](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1175)
___
@@ -1236,7 +1320,7 @@ ___
#### Defined in
[packages/medusa/src/services/cart.ts:1824](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1824)
[packages/medusa/src/services/cart.ts:1862](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1862)
___
@@ -1261,7 +1345,7 @@ a boolean indicating validation result
#### Defined in
[packages/medusa/src/services/cart.ts:583](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L583)
[packages/medusa/src/services/cart.ts:636](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L636)
___
@@ -1288,7 +1372,7 @@ boolean representing whether shipping method is validated
#### Defined in
[packages/medusa/src/services/cart.ts:552](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L552)
[packages/medusa/src/services/cart.ts:605](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L605)
___
@@ -1312,4 +1396,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ClaimItemService.md
+26 -26
View File
@@ -20,11 +20,11 @@
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L30)
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L30)
## Properties
@@ -34,11 +34,11 @@ BaseService.constructor
#### Inherited from
BaseService.\_\_configModule\_\_
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -48,11 +48,11 @@ ___
#### Inherited from
BaseService.\_\_container\_\_
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L25)
[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L25)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L23)
[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L23)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L24)
[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L24)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L22)
[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L22)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L21)
[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L21)
___
@@ -112,11 +112,11 @@ ___
#### Overrides
BaseService.manager\_
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L27)
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L27)
___
@@ -126,11 +126,11 @@ ___
#### Overrides
BaseService.transactionManager\_
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L28)
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L28)
___
@@ -148,7 +148,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L15)
[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L15)
## Methods
@@ -183,11 +183,11 @@ the result of the transactional work
#### Inherited from
BaseService.atomicPhase\_
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -207,7 +207,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L49)
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L49)
___
@@ -230,7 +230,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L214)
[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L214)
___
@@ -255,7 +255,7 @@ the ClaimItem
#### Defined in
[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L233)
[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L233)
___
@@ -275,11 +275,11 @@ ___
#### Inherited from
BaseService.shouldRetryTransaction\_
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -300,7 +300,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L132)
[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L132)
___
@@ -320,8 +320,8 @@ ___
#### Inherited from
BaseService.withTransaction
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ClaimService.md
+34 -34
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L83)
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L83)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L66)
[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L66)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L70)
[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L70)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L67)
[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L67)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L71)
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L71)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L72)
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L72)
___
@@ -112,7 +112,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L73)
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L73)
___
@@ -122,7 +122,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L74)
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L74)
___
@@ -132,7 +132,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L69)
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L69)
___
@@ -142,7 +142,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L75)
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L75)
___
@@ -156,7 +156,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L63)
[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L63)
___
@@ -166,7 +166,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L76)
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L76)
___
@@ -176,7 +176,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L77)
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L77)
___
@@ -186,7 +186,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L78)
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L78)
___
@@ -196,7 +196,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L68)
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L68)
___
@@ -206,7 +206,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L79)
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L79)
___
@@ -216,7 +216,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L80)
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L80)
___
@@ -226,7 +226,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L81)
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L81)
___
@@ -240,7 +240,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L64)
[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L64)
___
@@ -261,7 +261,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L54)
[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L54)
## Methods
@@ -300,7 +300,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -320,7 +320,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L761)
[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L761)
___
@@ -340,7 +340,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:609](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L609)
[packages/medusa/src/services/claim.ts:609](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L609)
___
@@ -366,7 +366,7 @@ created claim
#### Defined in
[packages/medusa/src/services/claim.ts:213](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L213)
[packages/medusa/src/services/claim.ts:213](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L213)
___
@@ -391,7 +391,7 @@ created claim
#### Defined in
[packages/medusa/src/services/claim.ts:463](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L463)
[packages/medusa/src/services/claim.ts:463](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L463)
___
@@ -416,7 +416,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:681](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L681)
[packages/medusa/src/services/claim.ts:681](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L681)
___
@@ -439,7 +439,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/claim.ts:817](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L817)
[packages/medusa/src/services/claim.ts:817](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L817)
___
@@ -459,7 +459,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L635)
[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L635)
___
@@ -484,7 +484,7 @@ the order document
#### Defined in
[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L837)
[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L837)
___
@@ -508,7 +508,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -529,7 +529,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L125)
[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L125)
___
@@ -553,4 +553,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/CurrencyService.md
+15 -15
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L32)
[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L32)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L28)
[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L28)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L29)
[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L29)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L30)
[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L30)
___
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L25)
[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L25)
___
@@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L26)
[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L26)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L21)
[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L21)
## Methods
@@ -165,7 +165,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -193,7 +193,7 @@ an array containing the currencies as
#### Defined in
[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L81)
[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L81)
___
@@ -217,7 +217,7 @@ The currency
#### Defined in
[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L50)
[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L50)
___
@@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -266,7 +266,7 @@ The updated currency
#### Defined in
[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L103)
[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L103)
___
@@ -290,4 +290,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/CustomShippingOptionService.md
+12 -12
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L19)
[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L20)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L17)
[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L18)
___
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L15)
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L15)
___
@@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L16)
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L16)
## Methods
@@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -153,7 +153,7 @@ resolves to the creation result
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L88)
[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L89)
___
@@ -178,7 +178,7 @@ custom shipping options matching the query
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L64)
[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L65)
___
@@ -203,7 +203,7 @@ the requested custom shipping option.
#### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L36)
[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L37)
___
@@ -227,7 +227,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -251,4 +251,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/CustomerGroupService.md
+136 -27
View File
@@ -1,12 +1,8 @@
# Class: CustomerGroupService
Provides layer to manipulate discounts.
**`Implements`**
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`
↳ **`CustomerGroupService`**
@@ -24,41 +20,87 @@ Provides layer to manipulate discounts.
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/customer-group.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L32)
[packages/medusa/src/services/customer-group.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L33)
## Properties
### customerGroupRepository\_
### \_\_configModule\_\_
• `Private` **customerGroupRepository\_**: typeof `CustomerGroupRepository`
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L28)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### customerGroupRepository\_
• `Protected` `Readonly` **customerGroupRepository\_**: typeof `CustomerGroupRepository`
#### Defined in
[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L30)
___
### customerService\_
• `Private` **customerService\_**: [`CustomerService`](CustomerService.md)
• `Protected` `Readonly` **customerService\_**: [`CustomerService`](CustomerService.md)
#### Defined in
[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L30)
[packages/medusa/src/services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L31)
___
### manager\_
• `Private` **manager\_**: `EntityManager`
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/customer-group.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L26)
[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L27)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L28)
## Methods
@@ -83,7 +125,46 @@ the customer group after insertion
#### Defined in
[packages/medusa/src/services/customer-group.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L114)
[packages/medusa/src/services/customer-group.ts:92](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L92)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -115,7 +196,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/customer-group.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L87)
[packages/medusa/src/services/customer-group.ts:68](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L68)
___
@@ -139,7 +220,7 @@ a promise
#### Defined in
[packages/medusa/src/services/customer-group.ts:195](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L195)
[packages/medusa/src/services/customer-group.ts:174](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L174)
___
@@ -164,7 +245,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/customer-group.ts:218](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L218)
[packages/medusa/src/services/customer-group.ts:197](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L197)
___
@@ -189,7 +270,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/customer-group.ts:237](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L237)
[packages/medusa/src/services/customer-group.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L216)
___
@@ -214,7 +295,7 @@ the customergroup with the provided id
#### Defined in
[packages/medusa/src/services/customer-group.ts:272](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L272)
[packages/medusa/src/services/customer-group.ts:252](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L252)
___
@@ -235,13 +316,37 @@ ___
#### Defined in
[packages/medusa/src/services/customer-group.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L63)
[packages/medusa/src/services/customer-group.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L45)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`customerGroupId`, `update`): `Promise`<`CustomerGroup`[]\>
▸ **update**(`customerGroupId`, `update`): `Promise`<`CustomerGroup`\>
Update a customer group.
@@ -254,30 +359,34 @@ Update a customer group.
#### Returns
`Promise`<`CustomerGroup`[]\>
`Promise`<`CustomerGroup`\>
resulting customer group
#### Defined in
[packages/medusa/src/services/customer-group.ts:163](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L163)
[packages/medusa/src/services/customer-group.ts:141](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L141)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`CustomerGroupService`](CustomerGroupService.md)
▸ **withTransaction**(`transactionManager?`): [`CustomerGroupService`](CustomerGroupService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `EntityManager` |
| `transactionManager?` | `EntityManager` |
#### Returns
[`CustomerGroupService`](CustomerGroupService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/services/customer-group.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L47)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/CustomerService.md
+28 -28
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L39)
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L39)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L27)
[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L27)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L26)
[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L26)
___
@@ -84,7 +84,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L28)
[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L28)
___
@@ -98,7 +98,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L30)
[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L30)
___
@@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L31)
[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L31)
___
@@ -130,7 +130,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L33)
[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L33)
## Methods
@@ -151,7 +151,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:461](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L461)
[packages/medusa/src/services/customer.ts:461](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L461)
___
@@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -208,7 +208,7 @@ the result of the count operation
#### Defined in
[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L158)
[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L158)
___
@@ -235,7 +235,7 @@ the result of create
#### Defined in
[packages/medusa/src/services/customer.ts:245](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L245)
[packages/medusa/src/services/customer.ts:245](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L245)
___
@@ -259,7 +259,7 @@ the result of the delete operation.
#### Defined in
[packages/medusa/src/services/customer.ts:509](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L509)
[packages/medusa/src/services/customer.ts:509](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L509)
___
@@ -287,7 +287,7 @@ the generated JSON web token
#### Defined in
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L64)
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L64)
___
@@ -311,7 +311,7 @@ hashed password
#### Defined in
[packages/medusa/src/services/customer.ts:232](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L232)
[packages/medusa/src/services/customer.ts:232](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L232)
___
@@ -334,7 +334,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L107)
[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L107)
___
@@ -357,7 +357,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L131)
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L131)
___
@@ -378,7 +378,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:444](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L444)
[packages/medusa/src/services/customer.ts:444](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L444)
___
@@ -403,7 +403,7 @@ the customer document.
#### Defined in
[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L220)
[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L220)
___
@@ -428,7 +428,7 @@ the customer document.
#### Defined in
[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L194)
[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L194)
___
@@ -453,7 +453,7 @@ the customer document.
#### Defined in
[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L207)
[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L207)
___
@@ -474,7 +474,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L164)
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L164)
___
@@ -498,7 +498,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -523,7 +523,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L300)
[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L300)
___
@@ -545,7 +545,7 @@ ___
#### Defined in
[packages/medusa/src/services/customer.ts:416](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L416)
[packages/medusa/src/services/customer.ts:416](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L416)
___
@@ -570,7 +570,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/customer.ts:364](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L364)
[packages/medusa/src/services/customer.ts:364](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L364)
___
@@ -594,4 +594,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/DiscountService.md
+40 -40
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L65)
[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L66)
## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L54)
[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L54)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L57)
[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L58)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L58)
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L59)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L53)
[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L53)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L55)
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L55)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L62)
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L63)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L63)
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L64)
___
@@ -136,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L56)
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L56)
___
@@ -150,7 +150,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/discount.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L50)
[packages/medusa/src/services/discount.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L50)
___
@@ -160,7 +160,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L60)
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L61)
___
@@ -170,7 +170,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L61)
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L62)
___
@@ -180,7 +180,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L59)
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L60)
___
@@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L51)
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L51)
## Methods
@@ -219,7 +219,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/discount.ts:470](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L470)
[packages/medusa/src/services/discount.ts:473](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L473)
___
@@ -258,7 +258,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -280,7 +280,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:571](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L571)
[packages/medusa/src/services/discount.ts:574](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L574)
___
@@ -301,7 +301,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:730](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L730)
[packages/medusa/src/services/discount.ts:733](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L733)
___
@@ -326,7 +326,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/discount.ts:181](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L181)
[packages/medusa/src/services/discount.ts:182](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L182)
___
@@ -351,7 +351,7 @@ the newly created dynamic code
#### Defined in
[packages/medusa/src/services/discount.ts:398](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L398)
[packages/medusa/src/services/discount.ts:401](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L401)
___
@@ -375,7 +375,7 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/discount.ts:530](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L530)
[packages/medusa/src/services/discount.ts:533](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L533)
___
@@ -400,7 +400,7 @@ the newly created dynamic code
#### Defined in
[packages/medusa/src/services/discount.ts:449](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L449)
[packages/medusa/src/services/discount.ts:452](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L452)
___
@@ -420,7 +420,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:699](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L699)
[packages/medusa/src/services/discount.ts:702](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L702)
___
@@ -440,7 +440,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:695](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L695)
[packages/medusa/src/services/discount.ts:698](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L698)
___
@@ -460,7 +460,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L689)
[packages/medusa/src/services/discount.ts:692](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L692)
___
@@ -480,7 +480,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:707](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L707)
[packages/medusa/src/services/discount.ts:710](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L710)
___
@@ -501,7 +501,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:711](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L711)
[packages/medusa/src/services/discount.ts:714](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L714)
___
@@ -524,7 +524,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/discount.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L119)
[packages/medusa/src/services/discount.ts:120](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L120)
___
@@ -547,7 +547,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/discount.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L135)
[packages/medusa/src/services/discount.ts:136](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L136)
___
@@ -572,7 +572,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/discount.ts:505](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L505)
[packages/medusa/src/services/discount.ts:508](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L508)
___
@@ -597,7 +597,7 @@ the discount
#### Defined in
[packages/medusa/src/services/discount.ts:246](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L246)
[packages/medusa/src/services/discount.ts:245](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L245)
___
@@ -622,7 +622,7 @@ the discount document
#### Defined in
[packages/medusa/src/services/discount.ts:272](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L272)
[packages/medusa/src/services/discount.ts:271](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L271)
___
@@ -646,7 +646,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -671,7 +671,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/discount.ts:303](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L303)
[packages/medusa/src/services/discount.ts:304](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L304)
___
@@ -692,7 +692,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:629](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L629)
[packages/medusa/src/services/discount.ts:632](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L632)
___
@@ -713,7 +713,7 @@ ___
#### Defined in
[packages/medusa/src/services/discount.ts:544](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L544)
[packages/medusa/src/services/discount.ts:547](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L547)
___
@@ -743,7 +743,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/discount.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L101)
[packages/medusa/src/services/discount.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L102)
___
@@ -767,4 +767,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/DraftOrderService.md
+25 -25
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L51)
[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L51)
## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L46)
[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L46)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L42)
[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L42)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L45)
[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L45)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L47)
[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L47)
___
@@ -110,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L39)
[packages/medusa/src/services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L39)
___
@@ -120,7 +120,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L44)
[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L44)
___
@@ -130,7 +130,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L43)
[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L43)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L48)
[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L48)
___
@@ -150,7 +150,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L49)
[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L49)
___
@@ -164,7 +164,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L40)
[packages/medusa/src/services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L40)
___
@@ -181,7 +181,7 @@ ___
#### Defined in
[packages/medusa/src/services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L34)
[packages/medusa/src/services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L34)
## Methods
@@ -220,7 +220,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -244,7 +244,7 @@ the created draft order
#### Defined in
[packages/medusa/src/services/draft-order.ts:245](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L245)
[packages/medusa/src/services/draft-order.ts:235](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L235)
___
@@ -268,7 +268,7 @@ empty promise
#### Defined in
[packages/medusa/src/services/draft-order.ts:144](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L144)
[packages/medusa/src/services/draft-order.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L134)
___
@@ -293,7 +293,7 @@ list of draft orders
#### Defined in
[packages/medusa/src/services/draft-order.ts:222](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L222)
[packages/medusa/src/services/draft-order.ts:212](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L212)
___
@@ -318,7 +318,7 @@ draft orders
#### Defined in
[packages/medusa/src/services/draft-order.ts:168](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L168)
[packages/medusa/src/services/draft-order.ts:158](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L158)
___
@@ -343,7 +343,7 @@ the created order
#### Defined in
[packages/medusa/src/services/draft-order.ts:357](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L357)
[packages/medusa/src/services/draft-order.ts:347](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L347)
___
@@ -368,7 +368,7 @@ the draft order
#### Defined in
[packages/medusa/src/services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L91)
[packages/medusa/src/services/draft-order.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L81)
___
@@ -393,7 +393,7 @@ the draft order
#### Defined in
[packages/medusa/src/services/draft-order.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L118)
[packages/medusa/src/services/draft-order.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L108)
___
@@ -417,7 +417,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -443,7 +443,7 @@ the updated draft order
#### Defined in
[packages/medusa/src/services/draft-order.ts:386](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L386)
[packages/medusa/src/services/draft-order.ts:376](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L376)
___
@@ -467,4 +467,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/EventBusService.md
+25 -25
View File
@@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously.
#### Defined in
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L38)
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L38)
## Properties
@@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously.
#### Defined in
[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L24)
[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L24)
___
@@ -39,7 +39,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L29)
[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L29)
___
@@ -49,7 +49,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L32)
[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L32)
___
@@ -59,7 +59,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L36)
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L36)
___
@@ -69,7 +69,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L26)
[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L26)
___
@@ -79,7 +79,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L25)
[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L25)
___
@@ -89,7 +89,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L28)
[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L28)
___
@@ -99,7 +99,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L33)
[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L33)
___
@@ -109,7 +109,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L30)
[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L30)
___
@@ -119,7 +119,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L31)
[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L31)
___
@@ -129,7 +129,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L34)
[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L34)
___
@@ -139,7 +139,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L27)
[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L27)
___
@@ -149,7 +149,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L35)
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L35)
## Methods
@@ -182,7 +182,7 @@ void
#### Defined in
[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L308)
[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L308)
___
@@ -215,7 +215,7 @@ resolves to the results of the subscriber calls.
#### Defined in
[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L281)
[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L281)
___
@@ -248,7 +248,7 @@ the job from our queue
#### Defined in
[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L179)
[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L179)
___
@@ -262,7 +262,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L215)
[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L215)
___
@@ -287,7 +287,7 @@ this
#### Defined in
[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L158)
[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L158)
___
@@ -301,7 +301,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L205)
[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L205)
___
@@ -315,7 +315,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L210)
[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L210)
___
@@ -340,7 +340,7 @@ this
#### Defined in
[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L118)
[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L118)
___
@@ -365,7 +365,7 @@ this
#### Defined in
[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L136)
[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L136)
___
@@ -385,7 +385,7 @@ ___
#### Defined in
[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L88)
[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L88)
___
@@ -418,4 +418,4 @@ resolves to the results of the subscriber calls.
#### Defined in
[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L250)
[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L250)
docs/content/references/services/classes/FulfillmentProviderService.md
+24 -24
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L43)
[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L43)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L39)
[packages/medusa/src/services/fulfillment-provider.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L39)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L41)
[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L41)
___
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L36)
[packages/medusa/src/services/fulfillment-provider.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L36)
___
@@ -102,7 +102,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L37)
[packages/medusa/src/services/fulfillment-provider.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L37)
## Methods
@@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -163,7 +163,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:148](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L148)
[packages/medusa/src/services/fulfillment-provider.ts:147](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L147)
___
@@ -183,7 +183,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L123)
[packages/medusa/src/services/fulfillment-provider.ts:122](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L122)
___
@@ -203,7 +203,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:141](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L141)
[packages/medusa/src/services/fulfillment-provider.ts:140](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L140)
___
@@ -226,7 +226,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L108)
[packages/medusa/src/services/fulfillment-provider.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L107)
___
@@ -246,7 +246,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:162](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L162)
[packages/medusa/src/services/fulfillment-provider.ts:161](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L161)
___
@@ -260,7 +260,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L67)
[packages/medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L67)
___
@@ -280,7 +280,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L75)
[packages/medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L75)
___
@@ -300,7 +300,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L53)
[packages/medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L53)
___
@@ -326,13 +326,13 @@ document to fetch
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:181](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L181)
[packages/medusa/src/services/fulfillment-provider.ts:180](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L180)
___
### retrieveProvider
▸ **retrieveProvider**(`providerId`): `BaseFulfillmentService`
▸ **retrieveProvider**(`providerId`): `any`
#### Parameters
@@ -342,13 +342,13 @@ ___
#### Returns
`BaseFulfillmentService`
`any`
the payment fulfillment provider
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L97)
[packages/medusa/src/services/fulfillment-provider.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L96)
___
@@ -372,7 +372,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -394,7 +394,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:128](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L128)
[packages/medusa/src/services/fulfillment-provider.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L127)
___
@@ -414,7 +414,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:157](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L157)
[packages/medusa/src/services/fulfillment-provider.ts:156](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L156)
___
@@ -438,4 +438,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/FulfillmentService.md
+22 -22
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L47)
[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L47)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L42)
[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L42)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L43)
[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L43)
___
@@ -84,7 +84,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L45)
[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L45)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L40)
[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L40)
___
@@ -108,7 +108,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L36)
[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L36)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L41)
[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L41)
___
@@ -128,7 +128,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L39)
[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L39)
___
@@ -138,7 +138,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L44)
[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L44)
___
@@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L37)
[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L37)
## Methods
@@ -191,7 +191,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -217,7 +217,7 @@ the result of the save operation
#### Defined in
[packages/medusa/src/services/fulfillment.ts:253](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L253)
[packages/medusa/src/services/fulfillment.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L253)
___
@@ -246,7 +246,7 @@ the created fulfillments
#### Defined in
[packages/medusa/src/services/fulfillment.ts:198](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L198)
[packages/medusa/src/services/fulfillment.ts:198](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L198)
___
@@ -273,7 +273,7 @@ the shipped fulfillment
#### Defined in
[packages/medusa/src/services/fulfillment.ts:303](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L303)
[packages/medusa/src/services/fulfillment.ts:303](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L303)
___
@@ -298,7 +298,7 @@ the line items generated by the transformer.
#### Defined in
[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L109)
[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L109)
___
@@ -319,7 +319,7 @@ ___
#### Defined in
[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L71)
[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L71)
___
@@ -344,7 +344,7 @@ the fulfillment
#### Defined in
[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L166)
[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L166)
___
@@ -368,7 +368,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -397,7 +397,7 @@ a line item that has the requested fulfillment quantity
#### Defined in
[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L134)
[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L134)
___
@@ -421,4 +421,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/GiftCardService.md
+23 -23
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L46)
[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L47)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L37)
[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L38)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L34)
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L34)
___
@@ -84,7 +84,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L35)
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L36)
___
@@ -98,7 +98,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L39)
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L40)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L36)
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L37)
___
@@ -122,7 +122,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L40)
[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L41)
___
@@ -138,7 +138,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L42)
[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L43)
## Methods
@@ -177,7 +177,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -201,7 +201,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/gift-card.ts:152](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L152)
[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L153)
___
@@ -221,7 +221,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:137](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L137)
[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L138)
___
@@ -245,7 +245,7 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/gift-card.ts:282](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L282)
[packages/medusa/src/services/gift-card.ts:283](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L283)
___
@@ -268,7 +268,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/gift-card.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L113)
[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L114)
___
@@ -291,7 +291,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L84)
[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L85)
___
@@ -316,7 +316,7 @@ the gift card
#### Defined in
[packages/medusa/src/services/gift-card.ts:216](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L216)
[packages/medusa/src/services/gift-card.ts:217](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L217)
___
@@ -337,7 +337,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:223](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L223)
[packages/medusa/src/services/gift-card.ts:224](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L224)
___
@@ -358,7 +358,7 @@ ___
#### Defined in
[packages/medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L182)
[packages/medusa/src/services/gift-card.ts:183](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L183)
___
@@ -382,7 +382,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -407,7 +407,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/gift-card.ts:236](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L236)
[packages/medusa/src/services/gift-card.ts:237](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L237)
___
@@ -431,7 +431,7 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -449,4 +449,4 @@ the generated gift card code
#### Defined in
[packages/medusa/src/services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L68)
[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L69)
docs/content/references/services/classes/IdempotencyKeyService.md
+15 -15
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L22)
[packages/medusa/src/services/idempotency-key.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L22)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L20)
[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L20)
___
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L17)
[packages/medusa/src/services/idempotency-key.ts:17](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L17)
___
@@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L18)
[packages/medusa/src/services/idempotency-key.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L18)
## Methods
@@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -155,7 +155,7 @@ the created idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L64)
[packages/medusa/src/services/idempotency-key.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L64)
___
@@ -182,7 +182,7 @@ the existing or created idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L38)
[packages/medusa/src/services/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L38)
___
@@ -206,7 +206,7 @@ result of the update operation
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L106)
[packages/medusa/src/services/idempotency-key.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L106)
___
@@ -230,7 +230,7 @@ idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L82)
[packages/medusa/src/services/idempotency-key.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L82)
___
@@ -254,7 +254,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -289,7 +289,7 @@ result of the update operation
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L135)
[packages/medusa/src/services/idempotency-key.ts:135](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L135)
___
@@ -313,7 +313,7 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -342,4 +342,4 @@ new updated idempotency key
#### Defined in
[packages/medusa/src/services/idempotency-key.ts:164](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L164)
[packages/medusa/src/services/idempotency-key.ts:164](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L164)
docs/content/references/services/classes/InventoryService.md
+11 -11
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L18)
[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L18)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L15)
[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L15)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L13)
[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L13)
___
@@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L16)
[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L16)
## Methods
@@ -115,7 +115,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L31)
[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L31)
___
@@ -154,7 +154,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -181,7 +181,7 @@ true if the inventory covers the quantity
#### Defined in
[packages/medusa/src/services/inventory.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L63)
[packages/medusa/src/services/inventory.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L64)
___
@@ -205,7 +205,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -229,4 +229,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/LineItemAdjustmentService.md
+392
View File
@@ -0,0 +1,392 @@
# Class: LineItemAdjustmentService
Provides layer to manipulate line item adjustments.
## Hierarchy
- `TransactionBaseService`
↳ **`LineItemAdjustmentService`**
## Constructors
### constructor
• **new LineItemAdjustmentService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `LineItemAdjustmentServiceProps` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L44)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### discountService
• `Private` `Readonly` **discountService**: [`DiscountService`](DiscountService.md)
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L42)
___
### lineItemAdjustmentRepo\_
• `Private` `Readonly` **lineItemAdjustmentRepo\_**: typeof `LineItemAdjustmentRepository`
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L41)
___
### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L38)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L39)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### create
▸ **create**(`data`): `Promise`<`LineItemAdjustment`\>
Creates a line item adjustment
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `Partial`<`LineItemAdjustment`\> | the line item adjustment to create |
#### Returns
`Promise`<`LineItemAdjustment`\>
line item adjustment
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L88)
___
### createAdjustmentForLineItem
▸ **createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<`LineItemAdjustment`[]\>
Creates adjustment for a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart` | `Cart` | the cart object holding discounts |
| `lineItem` | `LineItem` | the line item for which a line item adjustment might be created |
#### Returns
`Promise`<`LineItemAdjustment`[]\>
a line item adjustment or undefined if no adjustment was created
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:249](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L249)
___
### createAdjustments
▸ **createAdjustments**(`cart`, `lineItem?`): `Promise`<`LineItemAdjustment`[] \| `LineItemAdjustment`[][]\>
Creates adjustment for a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart` | `Cart` | the cart object holding discounts |
| `lineItem?` | `LineItem` | the line item for which a line item adjustment might be created |
#### Returns
`Promise`<`LineItemAdjustment`[] \| `LineItemAdjustment`[][]\>
if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created
otherwise returns an array of line item adjustments for each line item in the cart
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L277)
___
### delete
▸ **delete**(`selectorOrIds`): `Promise`<`void`\>
Deletes line item adjustments matching a selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selectorOrIds` | `string` \| `string`[] \| `FilterableLineItemAdjustmentProps` | the query object for find or the line item adjustment id |
#### Returns
`Promise`<`void`\>
the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L153)
___
### generateAdjustments
▸ **generateAdjustments**(`cart`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\>
Creates adjustment for a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart` | `Cart` | the cart object holding discounts |
| `generatedLineItem` | `LineItem` | the line item for which a line item adjustment might be created |
| `context` | `AdjustmentContext` | the line item for which a line item adjustment might be created |
#### Returns
`Promise`<`GeneratedAdjustment`[]\>
a line item adjustment or undefined if no adjustment was created
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:182](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L182)
___
### list
▸ **list**(`selector?`, `config?`): `Promise`<`LineItemAdjustment`[]\>
Lists line item adjustments
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableLineItemAdjustmentProps` | the query object for find |
| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to be used for find |
#### Returns
`Promise`<`LineItemAdjustment`[]\>
the result of the find operation
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L136)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<`LineItemAdjustment`\>
Retrieves a line item adjustment by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the line item adjustment to retrieve |
| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to retrieve the line item adjustment by |
#### Returns
`Promise`<`LineItemAdjustment`\>
the line item adjustment.
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L63)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`id`, `data`): `Promise`<`LineItemAdjustment`\>
Creates a line item adjustment
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the line item adjustment id to update |
| `data` | `Partial`<`LineItemAdjustment`\> | the line item adjustment to create |
#### Returns
`Promise`<`LineItemAdjustment`\>
line item adjustment
#### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L105)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/LineItemService.md
+245 -35
View File
@@ -1,10 +1,8 @@
# Class: LineItemService
Provides layer to manipulate line items.
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`
↳ **`LineItemService`**
@@ -22,21 +20,49 @@ Provides layer to manipulate line items.
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L52)
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L53)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### cartRepository\_
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository`
#### Defined in
[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L44)
[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L44)
___
@@ -46,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L49)
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L49)
___
@@ -56,17 +82,17 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L43)
[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L43)
___
### lineItemAdjustmentService\_
• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService`
• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Defined in
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L50)
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L50)
___
@@ -76,17 +102,21 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L42)
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L42)
___
### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager`
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L41)
[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L39)
___
@@ -96,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L47)
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L47)
___
@@ -106,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L46)
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L46)
___
@@ -116,7 +146,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L45)
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L45)
___
@@ -126,10 +156,137 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L48)
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L48)
___
### taxProviderService\_
• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md)
#### Defined in
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L51)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L40)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### cloneTo
▸ **cloneTo**(`ids`, `data?`, `options?`): `Promise`<`LineItem`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `ids` | `string` \| `string`[] |
| `data` | `Object` |
| `data.adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; }...)[] |
| `data.allow_discounts?` | `boolean` |
| `data.cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: ... |
| `data.cart_id?` | `string` |
| `data.claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } |
| `data.claim_order_id?` | `string` |
| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.description?` | `string` |
| `data.discount_total?` | ``null`` \| `number` |
| `data.fulfilled_quantity?` | `number` |
| `data.gift_card_total?` | ``null`` \| `number` |
| `data.has_shipping?` | `boolean` |
| `data.id?` | `string` |
| `data.includes_tax?` | `boolean` |
| `data.is_giftcard?` | `boolean` |
| `data.is_return?` | `boolean` |
| `data.metadata?` | { [x: string]: unknown; } |
| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_edit_id?` | ``null`` \| `string` |
| `data.order_id?` | ``null`` \| `string` |
| `data.original_item_id?` | ``null`` \| `string` |
| `data.original_tax_total?` | ``null`` \| `number` |
| `data.original_total?` | ``null`` \| `number` |
| `data.quantity?` | `number` |
| `data.refundable?` | ``null`` \| `number` |
| `data.returned_quantity?` | `number` |
| `data.shipped_quantity?` | `number` |
| `data.should_merge?` | `boolean` |
| `data.subtotal?` | ``null`` \| `number` |
| `data.swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.swap_id?` | `string` |
| `data.tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] |
| `data.tax_total?` | ``null`` \| `number` |
| `data.thumbnail?` | ``null`` \| `string` |
| `data.title?` | `string` |
| `data.total?` | ``null`` \| `number` |
| `data.unit_price?` | `number` |
| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 29 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 22 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.variant_id?` | `string` |
| `options` | `Object` |
| `options.setOriginalLineItemId?` | `boolean` |
#### Returns
`Promise`<`LineItem`[]\>
#### Defined in
[packages/medusa/src/services/line-item.ts:394](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L394)
___
### create
▸ **create**(`data`): `Promise`<`LineItem`\>
@@ -150,7 +307,7 @@ the created line item
#### Defined in
[packages/medusa/src/services/line-item.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L292)
[packages/medusa/src/services/line-item.ts:278](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L278)
___
@@ -176,7 +333,7 @@ the created line items
#### Defined in
[packages/medusa/src/services/line-item.ts:149](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L149)
[packages/medusa/src/services/line-item.ts:128](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L128)
___
@@ -194,7 +351,7 @@ Create a line item tax line.
| `args.code?` | ``null`` \| `string` | - |
| `args.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `args.id?` | `string` | - |
| `args.item?` | { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 34 more ...; updated\_at?: {... | - |
| `args.item?` | { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {... | - |
| `args.item_id?` | `string` | - |
| `args.metadata?` | { [x: string]: unknown; } | - |
| `args.name?` | `string` | - |
@@ -209,7 +366,7 @@ a new line item tax line
#### Defined in
[packages/medusa/src/services/line-item.ts:359](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L359)
[packages/medusa/src/services/line-item.ts:386](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L386)
___
@@ -233,7 +390,31 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:340](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L340)
[packages/medusa/src/services/line-item.ts:346](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L346)
___
### deleteWithTaxLines
▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| `LineItem`\>
Deletes a line item with the tax lines.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the line item to delete |
#### Returns
`Promise`<`undefined` \| `LineItem`\>
the result of the delete operation
#### Defined in
[packages/medusa/src/services/line-item.ts:365](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L365)
___
@@ -253,6 +434,7 @@ ___
| `context.customer_id?` | `string` |
| `context.includes_tax?` | `boolean` |
| `context.metadata?` | `Record`<`string`, `unknown`\> |
| `context.order_edit_id?` | `string` |
| `context.unit_price?` | `number` |
#### Returns
@@ -261,7 +443,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:202](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L202)
[packages/medusa/src/services/line-item.ts:181](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L181)
___
@@ -273,7 +455,7 @@ ___
| Name | Type |
| :------ | :------ |
| `selector` | `any` |
| `selector` | `Selector`<`LineItem`\> |
| `config` | `FindConfig`<`LineItem`\> |
#### Returns
@@ -282,7 +464,7 @@ ___
#### Defined in
[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L101)
[packages/medusa/src/services/line-item.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L81)
___
@@ -307,13 +489,37 @@ the line item
#### Defined in
[packages/medusa/src/services/line-item.ts:121](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L121)
[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L101)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`id`, `data`): `Promise`<`LineItem`\>
▸ **update**(`idOrSelector`, `data`): `Promise`<`LineItem`[]\>
Updates a line item
@@ -321,35 +527,39 @@ Updates a line item
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the line item to update |
| `data` | `Partial`<`LineItem`\> | the properties to update on line item |
| `idOrSelector` | `string` \| `Selector`<`LineItem`\> | the id or selector of the line item(s) to update |
| `data` | `Partial`<`LineItem`\> | the properties to update the line item(s) |
#### Returns
`Promise`<`LineItem`\>
`Promise`<`LineItem`[]\>
the update line item
the updated line item(s)
#### Defined in
[packages/medusa/src/services/line-item.ts:311](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L311)
[packages/medusa/src/services/line-item.ts:297](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L297)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`LineItemService`](LineItemService.md)
▸ **withTransaction**(`transactionManager?`): [`LineItemService`](LineItemService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `EntityManager` |
| `transactionManager?` | `EntityManager` |
#### Returns
[`LineItemService`](LineItemService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/services/line-item.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L78)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/MiddlewareService.md
+14 -14
View File
@@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
#### Defined in
[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L22)
[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L22)
## Properties
@@ -20,7 +20,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
#### Defined in
[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L17)
[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L17)
___
@@ -30,7 +30,7 @@ ___
#### Defined in
[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L18)
[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L18)
___
@@ -40,7 +40,7 @@ ___
#### Defined in
[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L19)
[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L19)
___
@@ -50,7 +50,7 @@ ___
#### Defined in
[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L20)
[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L20)
## Methods
@@ -75,7 +75,7 @@ void
#### Defined in
[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L60)
[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L60)
___
@@ -100,7 +100,7 @@ void
#### Defined in
[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L79)
[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L79)
___
@@ -122,7 +122,7 @@ Adds a middleware function to be called before cart creation
#### Defined in
[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L96)
[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L96)
___
@@ -143,7 +143,7 @@ ___
#### Defined in
[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L29)
[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L29)
___
@@ -163,7 +163,7 @@ ___
#### Defined in
[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L34)
[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L34)
___
@@ -185,7 +185,7 @@ Adds post authentication middleware to an express app.
#### Defined in
[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L106)
[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L106)
___
@@ -207,7 +207,7 @@ Adds pre authentication middleware to an express app.
#### Defined in
[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L117)
[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L117)
___
@@ -221,7 +221,7 @@ ___
#### Defined in
[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L123)
[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L123)
___
@@ -245,4 +245,4 @@ nothing if the middleware is a function
#### Defined in
[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L43)
[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L43)
docs/content/references/services/classes/NoteService.md
+16 -16
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L29)
[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L29)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L27)
[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L27)
___
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L24)
[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L24)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L26)
[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L26)
___
@@ -100,7 +100,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L25)
[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L25)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L18)
[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L18)
## Methods
@@ -157,7 +157,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -183,7 +183,7 @@ resolves to the creation result
#### Defined in
[packages/medusa/src/services/note.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L96)
[packages/medusa/src/services/note.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L96)
___
@@ -205,7 +205,7 @@ Deletes a given note
#### Defined in
[packages/medusa/src/services/note.ts:154](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L154)
[packages/medusa/src/services/note.ts:154](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L154)
___
@@ -230,7 +230,7 @@ notes related to the given search.
#### Defined in
[packages/medusa/src/services/note.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L75)
[packages/medusa/src/services/note.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L75)
___
@@ -255,7 +255,7 @@ which resolves to the requested note.
#### Defined in
[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L47)
[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L47)
___
@@ -279,7 +279,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -304,7 +304,7 @@ resolves to the updated element
#### Defined in
[packages/medusa/src/services/note.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L132)
[packages/medusa/src/services/note.ts:132](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L132)
___
@@ -328,4 +328,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/NotificationService.md
+23 -23
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/notification.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L35)
[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L36)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L27)
[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L27)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L28)
[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L28)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L31)
[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L31)
___
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L23)
[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L23)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/notification.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L33)
[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L34)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L32)
[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L32)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L26)
[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L26)
___
@@ -140,7 +140,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L24)
[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L24)
## Methods
@@ -179,7 +179,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -206,7 +206,7 @@ the result of notification subscribed
#### Defined in
[packages/medusa/src/services/notification.ts:173](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L173)
[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L174)
___
@@ -231,7 +231,7 @@ the notifications that satisfy the query.
#### Defined in
[packages/medusa/src/services/notification.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L85)
[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L86)
___
@@ -254,7 +254,7 @@ used to generate on demand invoices or other documents.
#### Defined in
[packages/medusa/src/services/notification.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L61)
[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L62)
___
@@ -276,7 +276,7 @@ Takes a list of notification provider ids and persists them in the database.
#### Defined in
[packages/medusa/src/services/notification.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L69)
[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L70)
___
@@ -302,7 +302,7 @@ the newly created notification
#### Defined in
[packages/medusa/src/services/notification.ts:253](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L253)
[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L254)
___
@@ -327,7 +327,7 @@ the notification
#### Defined in
[packages/medusa/src/services/notification.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L106)
[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L107)
___
@@ -352,7 +352,7 @@ the notification provider
#### Defined in
[packages/medusa/src/services/notification.ts:154](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L154)
[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L155)
___
@@ -379,7 +379,7 @@ the created notification
#### Defined in
[packages/medusa/src/services/notification.ts:205](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L205)
[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L206)
___
@@ -403,7 +403,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -426,7 +426,7 @@ Subscribes a given provider to an event.
#### Defined in
[packages/medusa/src/services/notification.ts:133](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L133)
[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L134)
___
@@ -450,4 +450,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/OauthService.md
+21 -21
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L31)
[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L31)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L27)
[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L27)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L29)
[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L29)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L26)
[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L26)
___
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L19)
[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L19)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L28)
[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L28)
___
@@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L20)
[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L20)
___
@@ -137,7 +137,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L21)
[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L21)
## Methods
@@ -176,7 +176,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -196,7 +196,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L81)
[packages/medusa/src/services/oauth.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L81)
___
@@ -218,7 +218,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L119)
[packages/medusa/src/services/oauth.ts:115](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L115)
___
@@ -238,7 +238,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L73)
[packages/medusa/src/services/oauth.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L73)
___
@@ -258,7 +258,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:153](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L153)
[packages/medusa/src/services/oauth.ts:149](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L149)
___
@@ -278,7 +278,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:109](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L109)
[packages/medusa/src/services/oauth.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L105)
___
@@ -298,7 +298,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L57)
[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L57)
___
@@ -318,7 +318,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L41)
[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L41)
___
@@ -342,7 +342,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -363,7 +363,7 @@ ___
#### Defined in
[packages/medusa/src/services/oauth.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L96)
[packages/medusa/src/services/oauth.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L94)
___
@@ -387,4 +387,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/OrderEditItemChangeService.md
+309
View File
@@ -0,0 +1,309 @@
# Class: OrderEditItemChangeService
## Hierarchy
- `TransactionBaseService`
↳ **`OrderEditItemChangeService`**
## Constructors
### constructor
• **new OrderEditItemChangeService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L34)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L30)
___
### lineItemService\_
• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L31)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L26)
___
### orderItemChangeRepository\_
• `Protected` `Readonly` **orderItemChangeRepository\_**: typeof `OrderItemChangeRepository`
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L29)
___
### taxProviderService\_
• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md)
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L32)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L27)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `CREATED` | `string` |
| `DELETED` | `string` |
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L21)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### create
▸ **create**(`data`): `Promise`<`OrderItemChange`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `CreateOrderEditItemChangeInput` |
#### Returns
`Promise`<`OrderItemChange`\>
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L86)
___
### delete
▸ **delete**(`itemChangeIds`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `itemChangeIds` | `string` \| `string`[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L102)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`OrderItemChange`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `selector` | `Selector`<`OrderItemChange`\> |
| `config` | `FindConfig`<`OrderItemChange`\> |
#### Returns
`Promise`<`OrderItemChange`[]\>
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L73)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<`OrderItemChange`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `config` | `FindConfig`<`OrderItemChange`\> |
#### Returns
`Promise`<`OrderItemChange`\>
#### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L51)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`OrderEditItemChangeService`](OrderEditItemChangeService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`OrderEditItemChangeService`](OrderEditItemChangeService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/OrderEditService.md
+471 -15
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/order-edit.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L27)
[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L65)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,37 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### eventBusService\_
• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L60)
___
### lineItemAdjustmentService\_
• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Defined in
[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L62)
___
### lineItemService\_
• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
#### Defined in
[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L59)
___
@@ -66,7 +96,17 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/order-edit.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L23)
[packages/medusa/src/services/order-edit.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L52)
___
### orderEditItemChangeService\_
• `Protected` `Readonly` **orderEditItemChangeService\_**: [`OrderEditItemChangeService`](OrderEditItemChangeService.md)
#### Defined in
[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L63)
___
@@ -76,7 +116,7 @@ ___
#### Defined in
[packages/medusa/src/services/order-edit.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L24)
[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L55)
___
@@ -86,7 +126,27 @@ ___
#### Defined in
[packages/medusa/src/services/order-edit.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L25)
[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L57)
___
### taxProviderService\_
• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md)
#### Defined in
[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L61)
___
### totalsService\_
• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](TotalsService.md)
#### Defined in
[packages/medusa/src/services/order-edit.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L58)
___
@@ -100,10 +160,52 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/order-edit.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L22)
[packages/medusa/src/services/order-edit.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L53)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `CANCELED` | `string` |
| `CONFIRMED` | `string` |
| `CREATED` | `string` |
| `DECLINED` | `string` |
| `REQUESTED` | `string` |
| `UPDATED` | `string` |
#### Defined in
[packages/medusa/src/services/order-edit.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L43)
## Methods
### addLineItem
▸ **addLineItem**(`orderEditId`, `data`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `data` | `AddOrderEditLineItemInput` |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:515](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L515)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
@@ -139,13 +241,142 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### computeLineItems
### cancel
▸ **computeLineItems**(`orderEditId`): `Promise`<{ `items`: `LineItem`[] ; `removedItems`: `LineItem`[] }\>
▸ **cancel**(`orderEditId`, `context?`): `Promise`<`OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `context` | `Object` |
| `context.loggedInUserId?` | `string` |
#### Returns
`Promise`<`OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:659](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L659)
___
### confirm
▸ **confirm**(`orderEditId`, `context?`): `Promise`<`OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `context` | `Object` |
| `context.loggedInUserId?` | `string` |
#### Returns
`Promise`<`OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:698](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L698)
___
### create
▸ **create**(`data`, `context`): `Promise`<`OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `CreateOrderEditInput` |
| `context` | `Object` |
| `context.loggedInUserId` | `string` |
#### Returns
`Promise`<`OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:175](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L175)
___
### decline
▸ **decline**(`orderEditId`, `context`): `Promise`<`OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `context` | `Object` |
| `context.declinedReason?` | `string` |
| `context.loggedInUserId?` | `string` |
#### Returns
`Promise`<`OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L277)
___
### decorateTotals
▸ **decorateTotals**(`orderEdit`): `Promise`<`OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEdit` | `OrderEdit` |
#### Returns
`Promise`<`OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:501](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L501)
___
### delete
▸ **delete**(`id`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L253)
___
### deleteClonedItems
▸ `Protected` **deleteClonedItems**(`orderEditId`): `Promise`<`void`\>
#### Parameters
@@ -155,11 +386,117 @@ ___
#### Returns
`Promise`<{ `items`: `LineItem`[] ; `removedItems`: `LineItem`[] }\>
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L64)
[packages/medusa/src/services/order-edit.ts:771](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L771)
___
### deleteItemChange
▸ **deleteItemChange**(`orderEditId`, `itemChangeId`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `itemChangeId` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:587](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L587)
___
### getTotals
▸ **getTotals**(`orderEditId`): `Promise`<{ `difference_due`: `number` ; `discount_total`: `number` ; `gift_card_tax_total`: `number` ; `gift_card_total`: `number` ; `shipping_total`: `number` ; `subtotal`: `number` ; `tax_total`: ``null`` \| `number` ; `total`: `number` }\>
Compute and return the different totals from the order edit id
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
#### Returns
`Promise`<{ `difference_due`: `number` ; `discount_total`: `number` ; `gift_card_tax_total`: `number` ; `gift_card_total`: `number` ; `shipping_total`: `number` ; `subtotal`: `number` ; `tax_total`: ``null`` \| `number` ; `total`: `number` }\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:116](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L116)
___
### refreshAdjustments
▸ **refreshAdjustments**(`orderEditId`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:458](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L458)
___
### removeLineItem
▸ **removeLineItem**(`orderEditId`, `lineItemId`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `lineItemId` | `string` |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:401](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L401)
___
### requestConfirmation
▸ **requestConfirmation**(`orderEditId`, `context?`): `Promise`<`OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `context` | `Object` |
| `context.loggedInUserId?` | `string` |
#### Returns
`Promise`<`OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:619](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L619)
___
@@ -180,7 +517,28 @@ ___
#### Defined in
[packages/medusa/src/services/order-edit.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L40)
[packages/medusa/src/services/order-edit.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L90)
___
### retrieveActive
▸ `Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| `OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderId` | `string` |
| `config` | `FindConfig`<`OrderEdit`\> |
#### Returns
`Promise`<`undefined` \| `OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:750](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L750)
___
@@ -204,7 +562,85 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`orderEditId`, `data`): `Promise`<`OrderEdit`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `data` | `Object` |
| `data.canceled_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.canceled_by?` | `string` |
| `data.changes?` | (`undefined` \| { type?: OrderEditItemChangeType \| undefined; order\_edit\_id?: string \| undefined; order\_edit?: { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; ... 51 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 7 ...)[] |
| `data.confirmed_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.confirmed_by?` | `string` |
| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.created_by?` | `string` |
| `data.declined_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.declined_by?` | `string` |
| `data.declined_reason?` | `string` |
| `data.difference_due?` | `number` |
| `data.discount_total?` | `number` |
| `data.gift_card_tax_total?` | `number` |
| `data.gift_card_total?` | `number` |
| `data.id?` | `string` |
| `data.internal_note?` | `string` |
| `data.items?` | (`undefined` \| { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {...)[] |
| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_id?` | `string` |
| `data.payment_collection?` | { type?: PaymentCollectionType \| undefined; status?: PaymentCollectionStatus \| undefined; description?: string \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.payment_collection_id?` | `string` |
| `data.requested_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.requested_by?` | `string` |
| `data.shipping_total?` | `number` |
| `data.status?` | `OrderEditStatus` |
| `data.subtotal?` | `number` |
| `data.tax_total?` | ``null`` \| `number` |
| `data.total?` | `number` |
| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.loadStatus?` | |
#### Returns
`Promise`<`OrderEdit`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:224](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L224)
___
### updateLineItem
▸ **updateLineItem**(`orderEditId`, `itemId`, `data`): `Promise`<`void`\>
Create or update order edit item change line item and apply the quantity
- If the item change already exists then update the quantity of the line item as well as the line adjustments
- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEditId` | `string` |
| `itemId` | `string` |
| `data` | `Object` |
| `data.quantity` | `number` |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/order-edit.ts:328](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L328)
___
@@ -228,4 +664,24 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### isOrderEditActive
▸ `Static` `Private` **isOrderEditActive**(`orderEdit`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `orderEdit` | `OrderEdit` |
#### Returns
`boolean`
#### Defined in
[packages/medusa/src/services/order-edit.ts:808](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L808)
docs/content/references/services/classes/OrderService.md
+60 -50
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L108)
[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L111)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L102)
[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L104)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L101)
[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L103)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L91)
[packages/medusa/src/services/order.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L93)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L95)
[packages/medusa/src/services/order.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L97)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L104)
[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L106)
___
@@ -112,7 +112,17 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L106)
[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L108)
___
### featureFlagRouter\_
• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L109)
___
@@ -122,7 +132,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L96)
[packages/medusa/src/services/order.ts:98](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L98)
___
@@ -132,7 +142,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L97)
[packages/medusa/src/services/order.ts:99](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L99)
___
@@ -142,7 +152,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L103)
[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L105)
___
@@ -152,7 +162,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L105)
[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L107)
___
@@ -162,7 +172,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L98)
[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L100)
___
@@ -176,7 +186,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/order.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L87)
[packages/medusa/src/services/order.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L89)
___
@@ -186,7 +196,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L90)
[packages/medusa/src/services/order.ts:92](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L92)
___
@@ -196,7 +206,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:92](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L92)
[packages/medusa/src/services/order.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L94)
___
@@ -206,7 +216,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L100)
[packages/medusa/src/services/order.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L102)
___
@@ -216,7 +226,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L93)
[packages/medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L95)
___
@@ -226,7 +236,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L94)
[packages/medusa/src/services/order.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L96)
___
@@ -236,7 +246,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L99)
[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L101)
___
@@ -250,7 +260,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/order.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L88)
[packages/medusa/src/services/order.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L90)
___
@@ -281,7 +291,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L68)
[packages/medusa/src/services/order.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L70)
## Methods
@@ -304,7 +314,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:831](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L831)
[packages/medusa/src/services/order.ts:835](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L835)
___
@@ -329,7 +339,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:1360](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1360)
[packages/medusa/src/services/order.ts:1361](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1361)
___
@@ -368,7 +378,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -394,7 +404,7 @@ result of the update operation.
#### Defined in
[packages/medusa/src/services/order.ts:985](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L985)
[packages/medusa/src/services/order.ts:988](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L988)
___
@@ -418,7 +428,7 @@ updated order
#### Defined in
[packages/medusa/src/services/order.ts:1297](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1297)
[packages/medusa/src/services/order.ts:1298](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1298)
___
@@ -442,7 +452,7 @@ result of the update operation.
#### Defined in
[packages/medusa/src/services/order.ts:1064](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1064)
[packages/medusa/src/services/order.ts:1066](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1066)
___
@@ -464,7 +474,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/order.ts:464](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L464)
[packages/medusa/src/services/order.ts:462](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L462)
___
@@ -488,7 +498,7 @@ resolves to the creation result.
#### Defined in
[packages/medusa/src/services/order.ts:492](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L492)
[packages/medusa/src/services/order.ts:490](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L490)
___
@@ -519,7 +529,7 @@ result of the update operation.
#### Defined in
[packages/medusa/src/services/order.ts:1170](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1170)
[packages/medusa/src/services/order.ts:1171](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1171)
___
@@ -548,7 +558,7 @@ the result of the refund operation.
#### Defined in
[packages/medusa/src/services/order.ts:1386](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1386)
[packages/medusa/src/services/order.ts:1387](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1387)
___
@@ -579,7 +589,7 @@ the resulting order following the update.
#### Defined in
[packages/medusa/src/services/order.ts:671](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L671)
[packages/medusa/src/services/order.ts:675](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L675)
___
@@ -600,7 +610,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:1435](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1435)
[packages/medusa/src/services/order.ts:1436](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1436)
___
@@ -624,7 +634,7 @@ the order document
#### Defined in
[packages/medusa/src/services/order.ts:455](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L455)
[packages/medusa/src/services/order.ts:453](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L453)
___
@@ -650,7 +660,7 @@ the line items generated by the transformer.
#### Defined in
[packages/medusa/src/services/order.ts:1339](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1339)
[packages/medusa/src/services/order.ts:1340](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1340)
___
@@ -673,7 +683,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/order.ts:156](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L156)
[packages/medusa/src/services/order.ts:161](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L161)
___
@@ -696,7 +706,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/order.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L191)
[packages/medusa/src/services/order.ts:195](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L195)
___
@@ -728,7 +738,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:1556](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1556)
[packages/medusa/src/services/order.ts:1557](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1557)
___
@@ -753,7 +763,7 @@ the order document
#### Defined in
[packages/medusa/src/services/order.ts:334](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L334)
[packages/medusa/src/services/order.ts:335](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L335)
___
@@ -778,7 +788,7 @@ the order document
#### Defined in
[packages/medusa/src/services/order.ts:375](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L375)
[packages/medusa/src/services/order.ts:375](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L375)
___
@@ -803,7 +813,7 @@ the order document
#### Defined in
[packages/medusa/src/services/order.ts:415](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L415)
[packages/medusa/src/services/order.ts:414](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L414)
___
@@ -827,7 +837,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -853,7 +863,7 @@ ___
#### Defined in
[packages/medusa/src/services/order.ts:257](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L257)
[packages/medusa/src/services/order.ts:260](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L260)
___
@@ -880,7 +890,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/order.ts:896](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L896)
[packages/medusa/src/services/order.ts:899](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L899)
___
@@ -905,7 +915,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:759](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L759)
[packages/medusa/src/services/order.ts:763](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L763)
___
@@ -930,7 +940,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/order.ts:799](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L799)
[packages/medusa/src/services/order.ts:803](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L803)
___
@@ -959,7 +969,7 @@ a line item that has the requested fulfillment quantity
#### Defined in
[packages/medusa/src/services/order.ts:1137](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1137)
[packages/medusa/src/services/order.ts:1138](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1138)
___
@@ -983,4 +993,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/PaymentCollectionService.md
+308
View File
@@ -0,0 +1,308 @@
# Class: PaymentCollectionService
## Hierarchy
- `TransactionBaseService`
↳ **`PaymentCollectionService`**
## Constructors
### constructor
• **new PaymentCollectionService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/payment-collection.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L32)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### eventBusService\_
• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/payment-collection.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L28)
___
### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/payment-collection.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L26)
___
### paymentCollectionRepository\_
• `Protected` `Readonly` **paymentCollectionRepository\_**: typeof `PaymentCollectionRepository`
#### Defined in
[packages/medusa/src/services/payment-collection.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L30)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/payment-collection.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L27)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `CREATED` | `string` |
| `DELETED` | `string` |
| `UPDATED` | `string` |
#### Defined in
[packages/medusa/src/services/payment-collection.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L20)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### create
▸ **create**(`data`): `Promise`<`PaymentCollection`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `CreatePaymentCollectionInput` |
#### Returns
`Promise`<`PaymentCollection`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L67)
___
### delete
▸ **delete**(`paymentCollectionId`): `Promise`<`undefined` \| `PaymentCollection`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentCollectionId` | `string` |
#### Returns
`Promise`<`undefined` \| `PaymentCollection`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:126](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L126)
___
### retrieve
▸ **retrieve**(`paymentCollectionId`, `config?`): `Promise`<`PaymentCollection`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentCollectionId` | `string` |
| `config` | `FindConfig`<`PaymentCollection`\> |
#### Returns
`Promise`<`PaymentCollection`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L45)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`paymentCollectionId`, `data`): `Promise`<`PaymentCollection`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `paymentCollectionId` | `string` |
| `data` | `Object` |
| `data.amount?` | `number` |
| `data.authorized_amount?` | `number` |
| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.created_by?` | `string` |
| `data.currency?` | { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } |
| `data.currency_code?` | `string` |
| `data.deleted_at?` | ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.description?` | `string` |
| `data.id?` | `string` |
| `data.metadata?` | { [x: string]: unknown; } |
| `data.payment_sessions?` | (`undefined` \| { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {...)[] |
| `data.payments?` | (`undefined` \| { swap\_id?: string \| undefined; swap?: { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; ... 21 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; })[] |
| `data.refunded_amount?` | `number` |
| `data.region?` | { name?: string \| undefined; currency\_code?: string \| undefined; currency?: { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.region_id?` | `string` |
| `data.status?` | `PaymentCollectionStatus` |
| `data.type?` | `ORDER_EDIT` |
| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
#### Returns
`Promise`<`PaymentCollection`\>
#### Defined in
[packages/medusa/src/services/payment-collection.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L97)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`PaymentCollectionService`](PaymentCollectionService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`PaymentCollectionService`](PaymentCollectionService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/PaymentProviderService.md
+34 -34
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/payment-provider.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L45)
[packages/medusa/src/services/payment-provider.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L46)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L39)
[packages/medusa/src/services/payment-provider.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L39)
___
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/payment-provider.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L37)
[packages/medusa/src/services/payment-provider.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L37)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L41)
[packages/medusa/src/services/payment-provider.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L42)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L42)
[packages/medusa/src/services/payment-provider.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L43)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L40)
[packages/medusa/src/services/payment-provider.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L40)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L43)
[packages/medusa/src/services/payment-provider.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L44)
___
@@ -132,7 +132,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/payment-provider.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L38)
[packages/medusa/src/services/payment-provider.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L38)
## Methods
@@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -192,7 +192,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:349](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L349)
[packages/medusa/src/services/payment-provider.ts:350](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L350)
___
@@ -212,7 +212,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:398](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L398)
[packages/medusa/src/services/payment-provider.ts:399](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L399)
___
@@ -232,7 +232,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:423](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L423)
[packages/medusa/src/services/payment-provider.ts:424](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L424)
___
@@ -252,7 +252,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:300](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L300)
[packages/medusa/src/services/payment-provider.ts:301](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L301)
___
@@ -277,7 +277,7 @@ the payment session
#### Defined in
[packages/medusa/src/services/payment-provider.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L158)
[packages/medusa/src/services/payment-provider.ts:159](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L159)
___
@@ -297,7 +297,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:246](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L246)
[packages/medusa/src/services/payment-provider.ts:247](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L247)
___
@@ -317,7 +317,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:418](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L418)
[packages/medusa/src/services/payment-provider.ts:419](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L419)
___
@@ -331,7 +331,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L75)
[packages/medusa/src/services/payment-provider.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L76)
___
@@ -352,7 +352,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L110)
[packages/medusa/src/services/payment-provider.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L111)
___
@@ -378,7 +378,7 @@ the payment session
#### Defined in
[packages/medusa/src/services/payment-provider.ts:189](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L189)
[packages/medusa/src/services/payment-provider.ts:190](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L190)
___
@@ -401,7 +401,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:443](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L443)
[packages/medusa/src/services/payment-provider.ts:444](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L444)
___
@@ -421,7 +421,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L56)
[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L57)
___
@@ -442,13 +442,13 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L82)
[packages/medusa/src/services/payment-provider.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L83)
___
### retrieveProvider
▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends `AbstractPaymentService`<`never`\> ? `AbstractPaymentService`<`never`\> : `any`
▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any`
Finds a provider given an id
@@ -466,13 +466,13 @@ Finds a provider given an id
#### Returns
`TProvider` extends `AbstractPaymentService`<`never`\> ? `AbstractPaymentService`<`never`\> : `any`
`TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any`
the payment provider
#### Defined in
[packages/medusa/src/services/payment-provider.ts:276](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L276)
[packages/medusa/src/services/payment-provider.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L277)
___
@@ -493,7 +493,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:527](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L527)
[packages/medusa/src/services/payment-provider.ts:528](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L528)
___
@@ -514,7 +514,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L123)
[packages/medusa/src/services/payment-provider.ts:124](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L124)
___
@@ -538,7 +538,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -561,7 +561,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:327](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L327)
[packages/medusa/src/services/payment-provider.ts:328](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L328)
___
@@ -586,7 +586,7 @@ the updated payment session
#### Defined in
[packages/medusa/src/services/payment-provider.ts:228](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L228)
[packages/medusa/src/services/payment-provider.ts:229](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L229)
___
@@ -607,7 +607,7 @@ ___
#### Defined in
[packages/medusa/src/services/payment-provider.ts:377](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L377)
[packages/medusa/src/services/payment-provider.ts:378](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L378)
___
@@ -631,4 +631,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/PriceListService.md
+615
View File
@@ -0,0 +1,615 @@
# Class: PriceListService
Provides layer to manipulate product tags.
## Hierarchy
- `TransactionBaseService`
↳ **`PriceListService`**
## Constructors
### constructor
• **new PriceListService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `PriceListConstructorProps` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/price-list.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L58)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### customerGroupService\_
• `Protected` `Readonly` **customerGroupService\_**: [`CustomerGroupService`](CustomerGroupService.md)
#### Defined in
[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L49)
___
### featureFlagRouter\_
• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[packages/medusa/src/services/price-list.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L56)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L46)
___
### moneyAmountRepo\_
• `Protected` `Readonly` **moneyAmountRepo\_**: typeof `MoneyAmountRepository`
#### Defined in
[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L54)
___
### priceListRepo\_
• `Protected` `Readonly` **priceListRepo\_**: typeof `PriceListRepository`
#### Defined in
[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L53)
___
### productService\_
• `Protected` `Readonly` **productService\_**: [`ProductService`](ProductService.md)
#### Defined in
[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L51)
___
### productVariantRepo\_
• `Protected` `Readonly` **productVariantRepo\_**: typeof `ProductVariantRepository`
#### Defined in
[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L55)
___
### regionService\_
• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md)
#### Defined in
[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L50)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/price-list.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L47)
___
### variantService\_
• `Protected` `Readonly` **variantService\_**: [`ProductVariantService`](ProductVariantService.md)
#### Defined in
[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L52)
## Methods
### addCurrencyFromRegion
▸ `Protected` **addCurrencyFromRegion**<`T`\>(`prices`): `Promise`<`T`[]\>
Add `currency_code` to an MA record if `region_id`is passed.
#### Type parameters
| Name | Type |
| :------ | :------ |
| `T` | extends `PriceListPriceUpdateInput` \| `PriceListPriceCreateInput` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `prices` | `T`[] | a list of PriceListPrice(Create/Update)Input records |
#### Returns
`Promise`<`T`[]\>
updated `prices` list
#### Defined in
[packages/medusa/src/services/price-list.ts:517](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L517)
___
### addPrices
▸ **addPrices**(`id`, `prices`, `replace?`): `Promise`<`PriceList`\>
Adds prices to a price list in bulk, optionally replacing all existing prices
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `id` | `string` | `undefined` | id of the price list |
| `prices` | `PriceListPriceCreateInput`[] | `undefined` | prices to add |
| `replace` | `boolean` | `false` | whether to replace existing prices |
#### Returns
`Promise`<`PriceList`\>
updated Price List
#### Defined in
[packages/medusa/src/services/price-list.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L216)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### clearPrices
▸ **clearPrices**(`id`): `Promise`<`void`\>
Removes all prices from a price list and deletes the removed prices in bulk
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the price list |
#### Returns
`Promise`<`void`\>
updated Price List
#### Defined in
[packages/medusa/src/services/price-list.ts:256](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L256)
___
### create
▸ **create**(`priceListObject`): `Promise`<`PriceList`\>
Creates a Price List
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `priceListObject` | `CreatePriceListInput` | the Price List to create |
#### Returns
`Promise`<`PriceList`\>
created Price List
#### Defined in
[packages/medusa/src/services/price-list.ts:113](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L113)
___
### delete
▸ **delete**(`id`): `Promise`<`void`\>
Deletes a Price List
Will never fail due to delete being idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the price list |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[packages/medusa/src/services/price-list.ts:270](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L270)
___
### deletePrices
▸ **deletePrices**(`id`, `priceIds`): `Promise`<`void`\>
Removes prices from a price list and deletes the removed prices in bulk
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the price list |
| `priceIds` | `string`[] | ids of the prices to delete |
#### Returns
`Promise`<`void`\>
updated Price List
#### Defined in
[packages/medusa/src/services/price-list.ts:241](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L241)
___
### deleteProductPrices
▸ **deleteProductPrices**(`priceListId`, `productIds`): `Promise`<[`string`[], `number`]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `priceListId` | `string` |
| `productIds` | `string`[] |
#### Returns
`Promise`<[`string`[], `number`]\>
#### Defined in
[packages/medusa/src/services/price-list.ts:444](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L444)
___
### deleteVariantPrices
▸ **deleteVariantPrices**(`priceListId`, `variantIds`): `Promise`<[`string`[], `number`]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `priceListId` | `string` |
| `variantIds` | `string`[] |
#### Returns
`Promise`<[`string`[], `number`]\>
#### Defined in
[packages/medusa/src/services/price-list.ts:481](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L481)
___
### list
▸ **list**(`selector?`, `config?`): `Promise`<`PriceList`[]\>
Lists Price Lists
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterablePriceListProps` | the query object for find |
| `config` | `FindConfig`<`FilterablePriceListProps`\> | the config to be used for find |
#### Returns
`Promise`<`PriceList`[]\>
the result of the find operation
#### Defined in
[packages/medusa/src/services/price-list.ts:290](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L290)
___
### listAndCount
▸ **listAndCount**(`selector?`, `config?`): `Promise`<[`PriceList`[], `number`]\>
Lists Price Lists and adds count
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterablePriceListProps` | the query object for find |
| `config` | `FindConfig`<`FilterablePriceListProps`\> | the config to be used for find |
#### Returns
`Promise`<[`PriceList`[], `number`]\>
the result of the find operation
#### Defined in
[packages/medusa/src/services/price-list.ts:314](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L314)
___
### listProducts
▸ **listProducts**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[`Product`[], `number`]\>
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `priceListId` | `string` | `undefined` |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | `{}` |
| `config` | `FindConfig`<`Product`\> | `undefined` |
| `requiresPriceList` | `boolean` | `false` |
#### Returns
`Promise`<[`Product`[], `number`]\>
#### Defined in
[packages/medusa/src/services/price-list.ts:362](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L362)
___
### listVariants
▸ **listVariants**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[`ProductVariant`[], `number`]\>
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `priceListId` | `string` | `undefined` |
| `selector` | `FilterableProductVariantProps` | `{}` |
| `config` | `FindConfig`<`ProductVariant`\> | `undefined` |
| `requiresPriceList` | `boolean` | `false` |
#### Returns
`Promise`<[`ProductVariant`[], `number`]\>
#### Defined in
[packages/medusa/src/services/price-list.ts:410](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L410)
___
### retrieve
▸ **retrieve**(`priceListId`, `config?`): `Promise`<`PriceList`\>
Retrieves a product tag by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `priceListId` | `string` | the id of the product tag to retrieve |
| `config` | `FindConfig`<`PriceList`\> | the config to retrieve the tag by |
#### Returns
`Promise`<`PriceList`\>
the collection.
#### Defined in
[packages/medusa/src/services/price-list.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L89)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### update
▸ **update**(`id`, `update`): `Promise`<`PriceList`\>
Updates a Price List
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | the id of the Product List to update |
| `update` | `UpdatePriceListInput` | the update to apply |
#### Returns
`Promise`<`PriceList`\>
updated Price List
#### Defined in
[packages/medusa/src/services/price-list.ts:165](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L165)
___
### upsertCustomerGroups\_
▸ `Protected` **upsertCustomerGroups_**(`priceListId`, `customerGroups`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `priceListId` | `string` |
| `customerGroups` | { `id`: `string` }[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/price-list.ts:343](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L343)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`PriceListService`](PriceListService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`PriceListService`](PriceListService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/PricingService.md
+25 -25
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/pricing.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L45)
[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L44)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/pricing.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L43)
[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L42)
___
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L37)
[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L36)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L41)
[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L40)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L42)
[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L41)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L39)
[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L38)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L40)
[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L39)
___
@@ -132,7 +132,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L38)
[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L37)
## Methods
@@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -196,7 +196,7 @@ The tax related variant prices.
#### Defined in
[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L105)
[packages/medusa/src/services/pricing.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L104)
___
@@ -221,7 +221,7 @@ The pricing context
#### Defined in
[packages/medusa/src/services/pricing.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L70)
[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L69)
___
@@ -247,7 +247,7 @@ A map of variant ids to their corresponding prices
#### Defined in
[packages/medusa/src/services/pricing.ts:324](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L324)
[packages/medusa/src/services/pricing.ts:323](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L323)
___
@@ -272,7 +272,7 @@ A map of variant ids to their corresponding prices
#### Defined in
[packages/medusa/src/services/pricing.ts:342](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L342)
[packages/medusa/src/services/pricing.ts:341](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L341)
___
@@ -294,7 +294,7 @@ ___
#### Defined in
[packages/medusa/src/services/pricing.ts:286](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L286)
[packages/medusa/src/services/pricing.ts:285](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L285)
___
@@ -319,7 +319,7 @@ The product variant prices
#### Defined in
[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L214)
[packages/medusa/src/services/pricing.ts:213](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L213)
___
@@ -344,7 +344,7 @@ The product variant prices
#### Defined in
[packages/medusa/src/services/pricing.ts:252](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L252)
[packages/medusa/src/services/pricing.ts:251](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L251)
___
@@ -366,7 +366,7 @@ ___
#### Defined in
[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L167)
[packages/medusa/src/services/pricing.ts:166](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L166)
___
@@ -391,7 +391,7 @@ The shipping option prices
#### Defined in
[packages/medusa/src/services/pricing.ts:428](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L428)
[packages/medusa/src/services/pricing.ts:427](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L427)
___
@@ -416,7 +416,7 @@ A list of products with variants decorated with prices
#### Defined in
[packages/medusa/src/services/pricing.ts:385](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L385)
[packages/medusa/src/services/pricing.ts:384](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L384)
___
@@ -441,7 +441,7 @@ A list of shipping options with prices
#### Defined in
[packages/medusa/src/services/pricing.ts:490](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L490)
[packages/medusa/src/services/pricing.ts:489](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L489)
___
@@ -466,7 +466,7 @@ A list of products with variants decorated with prices
#### Defined in
[packages/medusa/src/services/pricing.ts:360](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L360)
[packages/medusa/src/services/pricing.ts:359](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L359)
___
@@ -490,7 +490,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -514,4 +514,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ProductCollectionService.md
+20 -20
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/product-collection.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L35)
[packages/medusa/src/services/product-collection.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L35)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/product-collection.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L30)
[packages/medusa/src/services/product-collection.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L30)
___
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L27)
[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L27)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L32)
[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L32)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/product-collection.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L33)
[packages/medusa/src/services/product-collection.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L33)
___
@@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/product-collection.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L28)
[packages/medusa/src/services/product-collection.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L28)
## Methods
@@ -133,7 +133,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/product-collection.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L184)
[packages/medusa/src/services/product-collection.ts:179](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L179)
___
@@ -172,7 +172,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -196,7 +196,7 @@ created collection
#### Defined in
[packages/medusa/src/services/product-collection.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L113)
[packages/medusa/src/services/product-collection.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L108)
___
@@ -220,7 +220,7 @@ empty promise
#### Defined in
[packages/medusa/src/services/product-collection.ts:166](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L166)
[packages/medusa/src/services/product-collection.ts:161](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L161)
___
@@ -247,7 +247,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/product-collection.ts:226](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L226)
[packages/medusa/src/services/product-collection.ts:221](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L221)
___
@@ -272,7 +272,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/product-collection.ts:244](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L244)
[packages/medusa/src/services/product-collection.ts:239](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L239)
___
@@ -293,7 +293,7 @@ ___
#### Defined in
[packages/medusa/src/services/product-collection.ts:205](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L205)
[packages/medusa/src/services/product-collection.ts:200](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L200)
___
@@ -318,7 +318,7 @@ the collection.
#### Defined in
[packages/medusa/src/services/product-collection.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L60)
[packages/medusa/src/services/product-collection.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L55)
___
@@ -343,7 +343,7 @@ the collection.
#### Defined in
[packages/medusa/src/services/product-collection.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L87)
[packages/medusa/src/services/product-collection.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L82)
___
@@ -367,7 +367,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -392,7 +392,7 @@ update collection
#### Defined in
[packages/medusa/src/services/product-collection.ts:136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L136)
[packages/medusa/src/services/product-collection.ts:131](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L131)
___
@@ -416,4 +416,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ProductService.md
+40 -40
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L73)
[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L73)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L63)
[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L63)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L64)
[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L64)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L60)
[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L60)
___
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L52)
[packages/medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L52)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L55)
[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L55)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L56)
[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L56)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L59)
[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L59)
___
@@ -136,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L58)
[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L58)
___
@@ -146,7 +146,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L57)
[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L57)
___
@@ -156,7 +156,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L61)
[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L61)
___
@@ -166,7 +166,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L62)
[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L62)
___
@@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L53)
[packages/medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L53)
___
@@ -198,7 +198,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L67)
[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L67)
___
@@ -208,7 +208,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L66)
[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L66)
## Methods
@@ -235,7 +235,7 @@ the result of the model update operation
#### Defined in
[packages/medusa/src/services/product.ts:635](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L635)
[packages/medusa/src/services/product.ts:635](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L635)
___
@@ -274,7 +274,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -298,7 +298,7 @@ the result of the count operation
#### Defined in
[packages/medusa/src/services/product.ts:176](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L176)
[packages/medusa/src/services/product.ts:176](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L176)
___
@@ -322,7 +322,7 @@ resolves to the creation result.
#### Defined in
[packages/medusa/src/services/product.ts:344](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L344)
[packages/medusa/src/services/product.ts:344](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L344)
___
@@ -347,7 +347,7 @@ empty promise
#### Defined in
[packages/medusa/src/services/product.ts:601](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L601)
[packages/medusa/src/services/product.ts:601](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L601)
___
@@ -372,7 +372,7 @@ the updated product
#### Defined in
[packages/medusa/src/services/product.ts:800](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L800)
[packages/medusa/src/services/product.ts:800](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L800)
___
@@ -394,7 +394,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:290](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L290)
[packages/medusa/src/services/product.ts:290](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L290)
___
@@ -419,7 +419,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L110)
[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L110)
___
@@ -447,7 +447,7 @@ an array containing the products as
#### Defined in
[packages/medusa/src/services/product.ts:146](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L146)
[packages/medusa/src/services/product.ts:146](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L146)
___
@@ -467,7 +467,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:330](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L330)
[packages/medusa/src/services/product.ts:330](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L330)
___
@@ -481,7 +481,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:321](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L321)
[packages/medusa/src/services/product.ts:321](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L321)
___
@@ -513,7 +513,7 @@ an object containing the query, relations and free-text
#### Defined in
[packages/medusa/src/services/product.ts:871](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L871)
[packages/medusa/src/services/product.ts:871](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L871)
___
@@ -534,7 +534,7 @@ ___
#### Defined in
[packages/medusa/src/services/product.ts:678](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L678)
[packages/medusa/src/services/product.ts:678](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L678)
___
@@ -560,7 +560,7 @@ the result of the find one operation.
#### Defined in
[packages/medusa/src/services/product.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L191)
[packages/medusa/src/services/product.ts:191](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L191)
___
@@ -586,7 +586,7 @@ the result of the find one operation.
#### Defined in
[packages/medusa/src/services/product.ts:221](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L221)
[packages/medusa/src/services/product.ts:221](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L221)
___
@@ -612,7 +612,7 @@ the result of the find one operation.
#### Defined in
[packages/medusa/src/services/product.ts:207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L207)
[packages/medusa/src/services/product.ts:207](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L207)
___
@@ -637,7 +637,7 @@ product option
#### Defined in
[packages/medusa/src/services/product.ts:781](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L781)
[packages/medusa/src/services/product.ts:781](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L781)
___
@@ -662,7 +662,7 @@ an array of variants
#### Defined in
[packages/medusa/src/services/product.ts:272](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L272)
[packages/medusa/src/services/product.ts:272](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L272)
___
@@ -688,7 +688,7 @@ the result of the find one operation.
#### Defined in
[packages/medusa/src/services/product.ts:236](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L236)
[packages/medusa/src/services/product.ts:236](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L236)
___
@@ -712,7 +712,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -739,7 +739,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/product.ts:443](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L443)
[packages/medusa/src/services/product.ts:443](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L443)
___
@@ -766,7 +766,7 @@ the updated product
#### Defined in
[packages/medusa/src/services/product.ts:724](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L724)
[packages/medusa/src/services/product.ts:724](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L724)
___
@@ -790,4 +790,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ProductTypeService.md
+128 -17
View File
@@ -1,10 +1,8 @@
# Class: ProductTypeService
Provides layer to manipulate products.
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`
↳ **`ProductTypeService`**
@@ -22,34 +20,119 @@ Provides layer to manipulate products.
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/product-type.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L16)
[packages/medusa/src/services/product-type.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L16)
## Properties
### manager\_
### \_\_configModule\_\_
• `Private` **manager\_**: `EntityManager`
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/services/product-type.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L14)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L11)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/product-type.ts:12](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L12)
___
### typeRepository\_
• `Private` **typeRepository\_**: typeof `ProductTypeRepository`
• `Protected` `Readonly` **typeRepository\_**: typeof `ProductTypeRepository`
#### Defined in
[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L15)
[packages/medusa/src/services/product-type.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L14)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### list
▸ **list**(`selector?`, `config?`): `Promise`<`ProductType`[]\>
@@ -71,7 +154,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L72)
[packages/medusa/src/services/product-type.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L56)
___
@@ -96,7 +179,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/product-type.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L88)
[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L72)
___
@@ -122,24 +205,52 @@ the result of the find one operation.
#### Defined in
[packages/medusa/src/services/product-type.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L47)
[packages/medusa/src/services/product-type.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L31)
___
### withTransaction
### shouldRetryTransaction\_
▸ **withTransaction**(`transactionManager`): [`ProductTypeService`](ProductTypeService.md)
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `EntityManager` |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`ProductTypeService`](ProductTypeService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`ProductTypeService`](ProductTypeService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/services/product-type.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L23)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ProductVariantService.md
+157 -71
View File
@@ -1,10 +1,8 @@
# Class: ProductVariantService
Provides layer to manipulate product variants.
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`
↳ **`ProductVariantService`**
@@ -22,101 +20,147 @@ Provides layer to manipulate product variants.
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L53)
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L53)
## Properties
### cartRepository\_
### \_\_configModule\_\_
• `Private` **cartRepository\_**: typeof `CartRepository`
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L51)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### cartRepository\_
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository`
#### Defined in
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L51)
___
### eventBus\_
• `Private` **eventBus\_**: [`EventBusService`](EventBusService.md)
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L46)
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L46)
___
### manager\_
• `Private` **manager\_**: `EntityManager`
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L43)
[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L41)
___
### moneyAmountRepository\_
• `Private` **moneyAmountRepository\_**: typeof `MoneyAmountRepository`
• `Protected` `Readonly` **moneyAmountRepository\_**: typeof `MoneyAmountRepository`
#### Defined in
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L49)
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L49)
___
### priceSelectionStrategy\_
• `Private` **priceSelectionStrategy\_**: `IPriceSelectionStrategy`
• `Protected` `Readonly` **priceSelectionStrategy\_**: `IPriceSelectionStrategy`
#### Defined in
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L48)
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L48)
___
### productOptionValueRepository\_
• `Private` **productOptionValueRepository\_**: typeof `ProductOptionValueRepository`
• `Protected` `Readonly` **productOptionValueRepository\_**: typeof `ProductOptionValueRepository`
#### Defined in
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L50)
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L50)
___
### productRepository\_
• `Private` **productRepository\_**: typeof `ProductRepository`
• `Protected` `Readonly` **productRepository\_**: typeof `ProductRepository`
#### Defined in
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L45)
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L45)
___
### productVariantRepository\_
• `Private` **productVariantRepository\_**: typeof `ProductVariantRepository`
• `Protected` `Readonly` **productVariantRepository\_**: typeof `ProductVariantRepository`
#### Defined in
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L44)
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L44)
___
### regionService\_
• `Private` **regionService\_**: [`RegionService`](RegionService.md)
• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md)
#### Defined in
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L47)
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L47)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L42)
___
@@ -134,7 +178,7 @@ ___
#### Defined in
[packages/medusa/src/services/product-variant.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L37)
[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L35)
## Methods
@@ -164,7 +208,46 @@ the result of the update operation.
#### Defined in
[packages/medusa/src/services/product-variant.ts:536](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L536)
[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L498)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -190,7 +273,7 @@ resolves to the creation result.
#### Defined in
[packages/medusa/src/services/product-variant.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L184)
[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L147)
___
@@ -215,7 +298,7 @@ empty promise
#### Defined in
[packages/medusa/src/services/product-variant.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L689)
[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L651)
___
@@ -241,7 +324,7 @@ empty promise
#### Defined in
[packages/medusa/src/services/product-variant.ts:563](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L563)
[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L525)
___
@@ -269,13 +352,13 @@ an array containing the products as the first element and the total
#### Defined in
[packages/medusa/src/services/product-variant.ts:795](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L795)
[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L724)
___
### getRegionPrice
▸ **getRegionPrice**(`variantId`, `context`): `Promise`<`number`\>
▸ **getRegionPrice**(`variantId`, `context`): `Promise`<``null`` \| `number`\>
Gets the price specific to a region. If no region specific money amount
exists the function will try to use a currency price. If no default
@@ -290,13 +373,13 @@ currency price exists the function will throw an error.
#### Returns
`Promise`<`number`\>
`Promise`<``null`` \| `number`\>
the price specific to the region
#### Defined in
[packages/medusa/src/services/product-variant.ts:411](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L411)
[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L374)
___
@@ -319,7 +402,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/product-variant.ts:631](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L631)
[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L593)
___
@@ -342,7 +425,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/product-variant.ts:590](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L590)
[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L552)
___
@@ -374,7 +457,7 @@ an object containing the query, relations and free-text
#### Defined in
[packages/medusa/src/services/product-variant.ts:756](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L756)
[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L685)
___
@@ -399,7 +482,7 @@ the product document.
#### Defined in
[packages/medusa/src/services/product-variant.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L118)
[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L83)
___
@@ -424,7 +507,7 @@ the product document.
#### Defined in
[packages/medusa/src/services/product-variant.ts:148](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L148)
[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L111)
___
@@ -449,32 +532,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/product-variant.ts:477](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L477)
___
### setMetadata\_
▸ **setMetadata_**(`variant`, `metadata`): `Record`<`string`, `unknown`\>
Dedicated method to set metadata for a variant.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variant` | `ProductVariant` | the variant to set metadata for. |
| `metadata` | `object` | the metadata to set |
#### Returns
`Record`<`string`, `unknown`\>
updated metadata object
#### Defined in
[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L724)
[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L439)
___
@@ -499,7 +557,31 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/product-variant.ts:440](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L440)
[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L403)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -526,7 +608,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/product-variant.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L292)
[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L255)
___
@@ -553,7 +635,7 @@ the result of the update operation.
#### Defined in
[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L498)
[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L460)
___
@@ -579,24 +661,28 @@ empty promise
#### Defined in
[packages/medusa/src/services/product-variant.ts:370](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L370)
[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L333)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`ProductVariantService`](ProductVariantService.md)
▸ **withTransaction**(`transactionManager?`): [`ProductVariantService`](ProductVariantService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `EntityManager` |
| `transactionManager?` | `EntityManager` |
#### Returns
[`ProductVariantService`](ProductVariantService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/services/product-variant.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L90)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/RegionService.md
+37 -37
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/region.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L66)
[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L67)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L60)
[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L59)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L61)
[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L60)
___
@@ -84,7 +84,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L55)
[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L54)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L53)
[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L52)
___
@@ -104,7 +104,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L63)
[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L64)
___
@@ -114,7 +114,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L58)
[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L57)
___
@@ -128,7 +128,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L51)
[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L50)
___
@@ -138,7 +138,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L62)
[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L62)
___
@@ -148,7 +148,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L57)
[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L56)
___
@@ -158,7 +158,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L59)
[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L58)
___
@@ -168,7 +168,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L56)
[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L55)
___
@@ -178,7 +178,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L64)
[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L65)
___
@@ -192,7 +192,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L52)
[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L51)
___
@@ -210,7 +210,7 @@ ___
#### Defined in
[packages/medusa/src/services/region.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L45)
[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L44)
## Methods
@@ -235,7 +235,7 @@ the updated Region
#### Defined in
[packages/medusa/src/services/region.ts:572](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L572)
[packages/medusa/src/services/region.ts:573](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L573)
___
@@ -261,7 +261,7 @@ the updated Region
#### Defined in
[packages/medusa/src/services/region.ts:702](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L702)
[packages/medusa/src/services/region.ts:703](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L703)
___
@@ -287,7 +287,7 @@ the updated Region
#### Defined in
[packages/medusa/src/services/region.ts:651](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L651)
[packages/medusa/src/services/region.ts:652](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L652)
___
@@ -326,7 +326,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -350,7 +350,7 @@ the newly created region
#### Defined in
[packages/medusa/src/services/region.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L116)
[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L117)
___
@@ -374,7 +374,7 @@ the result of the delete operation
#### Defined in
[packages/medusa/src/services/region.ts:541](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L541)
[packages/medusa/src/services/region.ts:542](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L542)
___
@@ -399,7 +399,7 @@ result of the find operation
#### Defined in
[packages/medusa/src/services/region.ts:521](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L521)
[packages/medusa/src/services/region.ts:522](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L522)
___
@@ -424,7 +424,7 @@ the updated Region
#### Defined in
[packages/medusa/src/services/region.ts:610](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L610)
[packages/medusa/src/services/region.ts:611](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L611)
___
@@ -449,7 +449,7 @@ the updated Region
#### Defined in
[packages/medusa/src/services/region.ts:790](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L790)
[packages/medusa/src/services/region.ts:791](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L791)
___
@@ -474,7 +474,7 @@ the updated Region
#### Defined in
[packages/medusa/src/services/region.ts:751](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L751)
[packages/medusa/src/services/region.ts:752](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L752)
___
@@ -499,7 +499,7 @@ the region
#### Defined in
[packages/medusa/src/services/region.ts:493](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L493)
[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L494)
___
@@ -524,7 +524,7 @@ a Region with country code
#### Defined in
[packages/medusa/src/services/region.ts:436](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L436)
[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L437)
___
@@ -548,7 +548,7 @@ region with the matching name
#### Defined in
[packages/medusa/src/services/region.ts:473](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L473)
[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L474)
___
@@ -572,7 +572,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -597,7 +597,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/region.ts:189](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L189)
[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L190)
___
@@ -623,7 +623,7 @@ the validated Country
#### Defined in
[packages/medusa/src/services/region.ts:387](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L387)
[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L388)
___
@@ -651,7 +651,7 @@ void
#### Defined in
[packages/medusa/src/services/region.ts:362](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L362)
[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L363)
___
@@ -683,7 +683,7 @@ the validated region data
#### Defined in
[packages/medusa/src/services/region.ts:260](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L260)
[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L261)
___
@@ -711,7 +711,7 @@ void
#### Defined in
[packages/medusa/src/services/region.ts:346](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L346)
[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L347)
___
@@ -735,4 +735,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ReturnReasonService.md
+14 -14
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L21)
[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L21)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L18)
[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L18)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L16)
[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L16)
___
@@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L19)
[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L19)
## Methods
@@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -149,7 +149,7 @@ ___
#### Defined in
[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L29)
[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L29)
___
@@ -169,7 +169,7 @@ ___
#### Defined in
[packages/medusa/src/services/return-reason.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L110)
[packages/medusa/src/services/return-reason.ts:110](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L110)
___
@@ -192,7 +192,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L72)
[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L72)
___
@@ -217,7 +217,7 @@ the order document
#### Defined in
[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L91)
[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L91)
___
@@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -262,7 +262,7 @@ ___
#### Defined in
[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L50)
[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L50)
___
@@ -286,4 +286,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ReturnService.md
+36 -33
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/return.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L64)
[packages/medusa/src/services/return.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L64)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L59)
[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L59)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L61)
[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L61)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L56)
[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L56)
___
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/return.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L50)
[packages/medusa/src/services/return.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L50)
___
@@ -106,7 +106,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L62)
[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L62)
___
@@ -116,7 +116,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L55)
[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L55)
___
@@ -126,7 +126,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L60)
[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L60)
___
@@ -136,7 +136,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L54)
[packages/medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L54)
___
@@ -146,7 +146,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L58)
[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L58)
___
@@ -156,7 +156,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L57)
[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L57)
___
@@ -166,7 +166,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L53)
[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L53)
___
@@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/return.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L51)
[packages/medusa/src/services/return.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L51)
## Methods
@@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -243,7 +243,7 @@ the updated Return
#### Defined in
[packages/medusa/src/services/return.ts:172](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L172)
[packages/medusa/src/services/return.ts:160](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L160)
___
@@ -269,7 +269,7 @@ the created return
#### Defined in
[packages/medusa/src/services/return.ts:350](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L350)
[packages/medusa/src/services/return.ts:338](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L338)
___
@@ -289,7 +289,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:496](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L496)
[packages/medusa/src/services/return.ts:484](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L484)
___
@@ -315,7 +315,7 @@ the line items generated by the transformer.
#### Defined in
[packages/medusa/src/services/return.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L114)
[packages/medusa/src/services/return.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L102)
___
@@ -338,7 +338,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/return.ts:154](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L154)
[packages/medusa/src/services/return.ts:142](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L142)
___
@@ -371,7 +371,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/return.ts:567](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L567)
[packages/medusa/src/services/return.ts:555](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L555)
___
@@ -396,7 +396,7 @@ the return
#### Defined in
[packages/medusa/src/services/return.ts:270](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L270)
[packages/medusa/src/services/return.ts:258](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L258)
___
@@ -417,7 +417,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:291](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L291)
[packages/medusa/src/services/return.ts:279](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L279)
___
@@ -441,7 +441,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -462,7 +462,7 @@ ___
#### Defined in
[packages/medusa/src/services/return.ts:316](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L316)
[packages/medusa/src/services/return.ts:304](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L304)
___
@@ -493,9 +493,9 @@ a line item where the quantity is set to the requested
| Name | Type |
| :------ | :------ |
| `adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 35 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 35 more ...; updated\_at?: { ...; }...)[] |
| `adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; }...)[] |
| `allow_discounts?` | `boolean` |
| `cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 34 more ...; updated\_at?: ... |
| `cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: ... |
| `cart_id?` | `string` |
| `claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } |
| `claim_order_id?` | `string` |
@@ -511,7 +511,10 @@ a line item where the quantity is set to the requested
| `is_return?` | `boolean` |
| `metadata?` | { [x: string]: unknown; } |
| `order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } |
| `order_id?` | `string` |
| `order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } |
| `order_edit_id?` | ``null`` \| `string` |
| `order_id?` | ``null`` \| `string` |
| `original_item_id?` | ``null`` \| `string` |
| `original_tax_total?` | ``null`` \| `number` |
| `original_total?` | ``null`` \| `number` |
| `quantity?` | `number` |
@@ -522,7 +525,7 @@ a line item where the quantity is set to the requested
| `subtotal?` | ``null`` \| `number` |
| `swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } |
| `swap_id?` | `string` |
| `tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 35 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 35 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] |
| `tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] |
| `tax_total?` | ``null`` \| `number` |
| `thumbnail?` | ``null`` \| `string` |
| `title?` | `string` |
@@ -534,7 +537,7 @@ a line item where the quantity is set to the requested
#### Defined in
[packages/medusa/src/services/return.ts:228](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L228)
[packages/medusa/src/services/return.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L216)
___
@@ -562,7 +565,7 @@ when statuses are not sufficient for returns.
#### Defined in
[packages/medusa/src/services/return.ts:198](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L198)
[packages/medusa/src/services/return.ts:186](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L186)
___
@@ -586,4 +589,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/SalesChannelService.md
+22 -22
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L37)
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L37)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L34)
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L34)
___
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L30)
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L30)
___
@@ -86,7 +86,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L33)
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L33)
___
@@ -96,7 +96,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L35)
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L35)
___
@@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L31)
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L31)
___
@@ -128,7 +128,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L24)
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L24)
## Methods
@@ -153,7 +153,7 @@ the sales channel on which the products have been added
#### Defined in
[packages/medusa/src/services/sales-channel.ts:310](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L310)
[packages/medusa/src/services/sales-channel.ts:305](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L305)
___
@@ -192,7 +192,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -219,7 +219,7 @@ the created channel
#### Defined in
[packages/medusa/src/services/sales-channel.ts:167](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L167)
[packages/medusa/src/services/sales-channel.ts:162](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L162)
___
@@ -237,7 +237,7 @@ the sales channel
#### Defined in
[packages/medusa/src/services/sales-channel.ts:257](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L257)
[packages/medusa/src/services/sales-channel.ts:252](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L252)
___
@@ -261,7 +261,7 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Defined in
[packages/medusa/src/services/sales-channel.ts:218](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L218)
[packages/medusa/src/services/sales-channel.ts:213](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L213)
___
@@ -289,7 +289,7 @@ an array containing the sales channels as
#### Defined in
[packages/medusa/src/services/sales-channel.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L132)
[packages/medusa/src/services/sales-channel.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L127)
___
@@ -314,7 +314,7 @@ the sales channel on which the products have been removed
#### Defined in
[packages/medusa/src/services/sales-channel.ts:289](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L289)
[packages/medusa/src/services/sales-channel.ts:284](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L284)
___
@@ -339,7 +339,7 @@ a sales channel
#### Defined in
[packages/medusa/src/services/sales-channel.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L104)
[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L99)
___
@@ -364,7 +364,7 @@ a sales channel with matching name
#### Defined in
[packages/medusa/src/services/sales-channel.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L118)
[packages/medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L113)
___
@@ -389,7 +389,7 @@ a single SC matching the query or throws
#### Defined in
[packages/medusa/src/services/sales-channel.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L64)
[packages/medusa/src/services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L59)
___
@@ -413,7 +413,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -434,7 +434,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L184)
[packages/medusa/src/services/sales-channel.ts:179](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L179)
___
@@ -458,4 +458,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/SearchService.md
+36 -40
View File
@@ -25,7 +25,7 @@ AbstractSearchService.constructor
#### Defined in
[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L18)
[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L18)
## Properties
@@ -39,7 +39,7 @@ AbstractSearchService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -53,7 +53,7 @@ AbstractSearchService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -67,7 +67,7 @@ AbstractSearchService.isDefault
#### Defined in
[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L11)
[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L11)
___
@@ -77,7 +77,7 @@ ___
#### Defined in
[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L15)
[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L15)
___
@@ -91,7 +91,7 @@ AbstractSearchService.manager\_
#### Defined in
[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L13)
[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L13)
___
@@ -105,7 +105,7 @@ AbstractSearchService.options\_
#### Defined in
[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L16)
[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L16)
___
@@ -119,7 +119,7 @@ AbstractSearchService.transactionManager\_
#### Defined in
[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L14)
[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L14)
## Accessors
@@ -137,13 +137,13 @@ AbstractSearchService.options
#### Defined in
[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/search-service.ts#L82)
[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/search-service.ts#L82)
## Methods
### addDocuments
▸ **addDocuments**(`indexName`, `documents`, `type`): `void`
▸ **addDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\>
#### Parameters
@@ -155,7 +155,7 @@ AbstractSearchService.options
#### Returns
`void`
`Promise`<`void`\>
#### Overrides
@@ -163,7 +163,7 @@ AbstractSearchService.addDocuments
#### Defined in
[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L43)
[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L43)
___
@@ -202,13 +202,13 @@ AbstractSearchService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### createIndex
▸ **createIndex**(`indexName`, `options`): `void`
▸ **createIndex**(`indexName`, `options`): `Promise`<`void`\>
#### Parameters
@@ -219,7 +219,7 @@ ___
#### Returns
`void`
`Promise`<`void`\>
#### Overrides
@@ -227,13 +227,13 @@ AbstractSearchService.createIndex
#### Defined in
[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L31)
[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L31)
___
### deleteAllDocuments
▸ **deleteAllDocuments**(`indexName`): `void`
▸ **deleteAllDocuments**(`indexName`): `Promise`<`void`\>
#### Parameters
@@ -243,7 +243,7 @@ ___
#### Returns
`void`
`Promise`<`void`\>
#### Overrides
@@ -251,13 +251,13 @@ AbstractSearchService.deleteAllDocuments
#### Defined in
[packages/medusa/src/services/search.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L61)
[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L72)
___
### deleteDocument
▸ **deleteDocument**(`indexName`, `document_id`): `void`
▸ **deleteDocument**(`indexName`, `document_id`): `Promise`<`void`\>
#### Parameters
@@ -268,7 +268,7 @@ ___
#### Returns
`void`
`Promise`<`void`\>
#### Overrides
@@ -276,13 +276,13 @@ AbstractSearchService.deleteDocument
#### Defined in
[packages/medusa/src/services/search.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L55)
[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L63)
___
### getIndex
▸ **getIndex**(`indexName`): `void`
▸ **getIndex**(`indexName`): `Promise`<`void`\>
#### Parameters
@@ -292,7 +292,7 @@ ___
#### Returns
`void`
`Promise`<`void`\>
#### Overrides
@@ -300,13 +300,13 @@ AbstractSearchService.getIndex
#### Defined in
[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L37)
[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L37)
___
### replaceDocuments
▸ **replaceDocuments**(`indexName`, `documents`, `type`): `void`
▸ **replaceDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\>
#### Parameters
@@ -318,7 +318,7 @@ ___
#### Returns
`void`
`Promise`<`void`\>
#### Overrides
@@ -326,13 +326,13 @@ AbstractSearchService.replaceDocuments
#### Defined in
[packages/medusa/src/services/search.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L49)
[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L53)
___
### search
▸ **search**(`indexName`, `query`, `options`): `Object`
▸ **search**(`indexName`, `query`, `options`): `Promise`<{ `hits`: `unknown`[] }\>
#### Parameters
@@ -344,11 +344,7 @@ ___
#### Returns
`Object`
| Name | Type |
| :------ | :------ |
| `hits` | `unknown`[] |
`Promise`<{ `hits`: `unknown`[] }\>
#### Overrides
@@ -356,7 +352,7 @@ AbstractSearchService.search
#### Defined in
[packages/medusa/src/services/search.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L67)
[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L78)
___
@@ -380,13 +376,13 @@ AbstractSearchService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
### updateSettings
▸ **updateSettings**(`indexName`, `settings`): `void`
▸ **updateSettings**(`indexName`, `settings`): `Promise`<`void`\>
#### Parameters
@@ -397,7 +393,7 @@ ___
#### Returns
`void`
`Promise`<`void`\>
#### Overrides
@@ -405,7 +401,7 @@ AbstractSearchService.updateSettings
#### Defined in
[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L78)
[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L89)
___
@@ -429,4 +425,4 @@ AbstractSearchService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ShippingOptionService.md
+29 -29
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L52)
[packages/medusa/src/services/shipping-option.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L54)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L47)
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L49)
___
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L49)
[packages/medusa/src/services/shipping-option.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L51)
___
@@ -88,7 +88,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L46)
[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L48)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L45)
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L47)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L42)
[packages/medusa/src/services/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L43)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L43)
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L44)
___
@@ -128,7 +128,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L44)
[packages/medusa/src/services/shipping-option.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L46)
___
@@ -142,7 +142,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L50)
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L52)
## Methods
@@ -168,7 +168,7 @@ the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:665](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L665)
[packages/medusa/src/services/shipping-option.ts:665](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L665)
___
@@ -207,7 +207,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -233,7 +233,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:405](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L405)
[packages/medusa/src/services/shipping-option.ts:407](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L407)
___
@@ -259,7 +259,7 @@ the resulting shipping method.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:268](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L268)
[packages/medusa/src/services/shipping-option.ts:270](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L270)
___
@@ -283,7 +283,7 @@ the result of the delete operation.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:643](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L643)
[packages/medusa/src/services/shipping-option.ts:643](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L643)
___
@@ -307,7 +307,7 @@ removed shipping methods
#### Defined in
[packages/medusa/src/services/shipping-option.ts:248](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L248)
[packages/medusa/src/services/shipping-option.ts:250](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L250)
___
@@ -335,7 +335,7 @@ the price of the shipping option.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:724](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L724)
[packages/medusa/src/services/shipping-option.ts:724](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L724)
___
@@ -358,7 +358,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:145](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L145)
[packages/medusa/src/services/shipping-option.ts:147](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L147)
___
@@ -381,7 +381,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-option.ts:161](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L161)
[packages/medusa/src/services/shipping-option.ts:163](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L163)
___
@@ -405,7 +405,7 @@ the result of update
#### Defined in
[packages/medusa/src/services/shipping-option.ts:694](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L694)
[packages/medusa/src/services/shipping-option.ts:694](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L694)
___
@@ -433,7 +433,7 @@ the profile document.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L179)
[packages/medusa/src/services/shipping-option.ts:181](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L181)
___
@@ -457,7 +457,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -484,7 +484,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/shipping-option.ts:529](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L529)
[packages/medusa/src/services/shipping-option.ts:529](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L529)
___
@@ -510,7 +510,7 @@ the resulting shipping method
#### Defined in
[packages/medusa/src/services/shipping-option.ts:219](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L219)
[packages/medusa/src/services/shipping-option.ts:221](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L221)
___
@@ -537,7 +537,7 @@ the validated shipping option
#### Defined in
[packages/medusa/src/services/shipping-option.ts:356](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L356)
[packages/medusa/src/services/shipping-option.ts:358](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L358)
___
@@ -562,7 +562,7 @@ the validated price
#### Defined in
[packages/medusa/src/services/shipping-option.ts:493](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L493)
[packages/medusa/src/services/shipping-option.ts:493](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L493)
___
@@ -587,7 +587,7 @@ a validated shipping requirement
#### Defined in
[packages/medusa/src/services/shipping-option.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L79)
[packages/medusa/src/services/shipping-option.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L81)
___
@@ -611,4 +611,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/ShippingProfileService.md
+27 -27
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L45)
[packages/medusa/src/services/shipping-profile.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L47)
## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L38)
[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L39)
___
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L42)
[packages/medusa/src/services/shipping-profile.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L44)
___
@@ -90,7 +90,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L40)
[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L42)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L36)
[packages/medusa/src/services/shipping-profile.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L37)
___
@@ -110,7 +110,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L37)
[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L38)
___
@@ -120,7 +120,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L39)
[packages/medusa/src/services/shipping-profile.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L41)
___
@@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L43)
[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L45)
## Methods
@@ -160,7 +160,7 @@ the result of update
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:358](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L358)
[packages/medusa/src/services/shipping-profile.ts:353](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L353)
___
@@ -186,7 +186,7 @@ the result of the model update operation
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:378](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L378)
[packages/medusa/src/services/shipping-profile.ts:373](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L373)
___
@@ -225,7 +225,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -249,7 +249,7 @@ the result of the create operation
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:247](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L247)
[packages/medusa/src/services/shipping-profile.ts:242](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L242)
___
@@ -267,7 +267,7 @@ the shipping profile
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:177](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L177)
[packages/medusa/src/services/shipping-profile.ts:172](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L172)
___
@@ -286,7 +286,7 @@ the shipping profile
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:221](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L221)
[packages/medusa/src/services/shipping-profile.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L216)
___
@@ -310,7 +310,7 @@ the result of the delete operation.
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:332](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L332)
[packages/medusa/src/services/shipping-profile.ts:327](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L327)
___
@@ -335,7 +335,7 @@ a list of the available shipping options
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:398](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L398)
[packages/medusa/src/services/shipping-profile.ts:393](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L393)
___
@@ -356,7 +356,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L87)
[packages/medusa/src/services/shipping-profile.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L82)
___
@@ -380,7 +380,7 @@ a list of product ids
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:468](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L468)
[packages/medusa/src/services/shipping-profile.ts:463](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L463)
___
@@ -403,7 +403,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L75)
[packages/medusa/src/services/shipping-profile.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L70)
___
@@ -429,7 +429,7 @@ the profile document.
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:139](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L139)
[packages/medusa/src/services/shipping-profile.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L134)
___
@@ -443,7 +443,7 @@ ___
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:161](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L161)
[packages/medusa/src/services/shipping-profile.ts:156](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L156)
___
@@ -461,7 +461,7 @@ the shipping profile for gift cards
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:204](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L204)
[packages/medusa/src/services/shipping-profile.ts:199](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L199)
___
@@ -485,7 +485,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -512,7 +512,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/shipping-profile.ts:275](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L275)
[packages/medusa/src/services/shipping-profile.ts:270](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L270)
___
@@ -536,4 +536,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/StoreService.md
+17 -17
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/store.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L32)
[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L31)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L29)
[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L28)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/store.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L30)
[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L29)
___
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L25)
[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L24)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L28)
[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L27)
___
@@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/store.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L26)
[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L25)
## Methods
@@ -136,7 +136,7 @@ result after update
#### Defined in
[packages/medusa/src/services/store.ts:210](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L210)
[packages/medusa/src/services/store.ts:209](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L209)
___
@@ -175,7 +175,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -193,7 +193,7 @@ The store.
#### Defined in
[packages/medusa/src/services/store.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L55)
[packages/medusa/src/services/store.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L54)
___
@@ -213,7 +213,7 @@ ___
#### Defined in
[packages/medusa/src/services/store.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L104)
[packages/medusa/src/services/store.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L103)
___
@@ -237,7 +237,7 @@ result after update
#### Defined in
[packages/medusa/src/services/store.ts:254](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L254)
[packages/medusa/src/services/store.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L253)
___
@@ -261,7 +261,7 @@ the store
#### Defined in
[packages/medusa/src/services/store.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L91)
[packages/medusa/src/services/store.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L90)
___
@@ -285,7 +285,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -309,7 +309,7 @@ resolves to the update result.
#### Defined in
[packages/medusa/src/services/store.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L120)
[packages/medusa/src/services/store.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L119)
___
@@ -333,4 +333,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/StrategyResolverService.md
+10 -10
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L14)
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L14)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L14)
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L14)
___
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L11)
[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L11)
___
@@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L12)
[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L12)
## Methods
@@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -149,7 +149,7 @@ ___
#### Defined in
[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L19)
[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L19)
___
@@ -173,7 +173,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -197,4 +197,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/SwapService.md
+38 -38
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/swap.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L93)
[packages/medusa/src/services/swap.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L93)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L80)
[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L80)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L91)
[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L91)
___
@@ -84,7 +84,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L81)
[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L81)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L87)
[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L87)
___
@@ -104,17 +104,17 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L86)
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L86)
___
### lineItemAdjustmentService\_
• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService`
• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md)
#### Defined in
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L90)
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L90)
___
@@ -124,7 +124,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L85)
[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L85)
___
@@ -138,7 +138,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L75)
[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L75)
___
@@ -148,7 +148,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L82)
[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L82)
___
@@ -158,7 +158,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L89)
[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L89)
___
@@ -168,7 +168,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L83)
[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L83)
___
@@ -178,7 +178,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L88)
[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L88)
___
@@ -188,7 +188,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L78)
[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L78)
___
@@ -198,7 +198,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L84)
[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L84)
___
@@ -212,7 +212,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L76)
[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L76)
___
@@ -236,7 +236,7 @@ ___
#### Defined in
[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L63)
[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L63)
## Methods
@@ -275,7 +275,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -301,7 +301,7 @@ the canceled swap.
#### Defined in
[packages/medusa/src/services/swap.ts:830](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L830)
[packages/medusa/src/services/swap.ts:830](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L830)
___
@@ -325,7 +325,7 @@ updated swap
#### Defined in
[packages/medusa/src/services/swap.ts:1031](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1031)
[packages/medusa/src/services/swap.ts:1031](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1031)
___
@@ -359,7 +359,7 @@ the newly created swap
#### Defined in
[packages/medusa/src/services/swap.ts:307](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L307)
[packages/medusa/src/services/swap.ts:307](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L307)
___
@@ -387,7 +387,7 @@ the swap with its cart_id prop set to the id of the new cart.
#### Defined in
[packages/medusa/src/services/swap.ts:556](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L556)
[packages/medusa/src/services/swap.ts:556](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L556)
___
@@ -413,7 +413,7 @@ the updated swap with new status and fulfillments.
#### Defined in
[packages/medusa/src/services/swap.ts:892](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L892)
[packages/medusa/src/services/swap.ts:892](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L892)
___
@@ -440,7 +440,7 @@ the updated swap with new fulfillments and status.
#### Defined in
[packages/medusa/src/services/swap.ts:1062](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1062)
[packages/medusa/src/services/swap.ts:1062](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1062)
___
@@ -465,7 +465,7 @@ resolves to the updated result.
#### Defined in
[packages/medusa/src/services/swap.ts:1140](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1140)
[packages/medusa/src/services/swap.ts:1140](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1140)
___
@@ -490,7 +490,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/swap.ts:277](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L277)
[packages/medusa/src/services/swap.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L277)
___
@@ -514,7 +514,7 @@ processed swap
#### Defined in
[packages/medusa/src/services/swap.ts:400](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L400)
[packages/medusa/src/services/swap.ts:400](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L400)
___
@@ -538,7 +538,7 @@ swap related to the cart
#### Defined in
[packages/medusa/src/services/swap.ts:679](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L679)
[packages/medusa/src/services/swap.ts:679](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L679)
___
@@ -563,7 +563,7 @@ the resulting order
#### Defined in
[packages/medusa/src/services/swap.ts:1180](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1180)
[packages/medusa/src/services/swap.ts:1180](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1180)
___
@@ -588,7 +588,7 @@ the swap
#### Defined in
[packages/medusa/src/services/swap.ts:208](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L208)
[packages/medusa/src/services/swap.ts:208](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L208)
___
@@ -613,7 +613,7 @@ the swap
#### Defined in
[packages/medusa/src/services/swap.ts:250](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L250)
[packages/medusa/src/services/swap.ts:250](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L250)
___
@@ -637,7 +637,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -661,7 +661,7 @@ transformed find swap config
#### Defined in
[packages/medusa/src/services/swap.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L135)
[packages/medusa/src/services/swap.ts:135](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L135)
___
@@ -686,7 +686,7 @@ updated swap record
#### Defined in
[packages/medusa/src/services/swap.ts:523](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L523)
[packages/medusa/src/services/swap.ts:523](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L523)
___
@@ -710,4 +710,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/SystemPaymentProviderService.md
+19 -19
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L10)
[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L10)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L5)
[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L5)
___
@@ -80,7 +80,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L6)
[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L6)
___
@@ -90,7 +90,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L8)
[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L8)
## Methods
@@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -149,7 +149,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L26)
[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L26)
___
@@ -169,7 +169,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L50)
[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L50)
___
@@ -189,7 +189,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L42)
[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L42)
___
@@ -209,7 +209,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L14)
[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L14)
___
@@ -229,7 +229,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L38)
[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L38)
___
@@ -249,7 +249,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L22)
[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L22)
___
@@ -269,7 +269,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L18)
[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L18)
___
@@ -289,7 +289,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L46)
[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L46)
___
@@ -313,7 +313,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -333,7 +333,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L34)
[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L34)
___
@@ -353,7 +353,7 @@ ___
#### Defined in
[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L30)
[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L30)
___
@@ -377,4 +377,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/TaxProviderService.md
+48 -28
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L53)
[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L53)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L45)
[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L45)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L51)
[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L51)
___
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L42)
[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L42)
___
@@ -98,7 +98,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L50)
[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L50)
___
@@ -108,7 +108,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L48)
[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L48)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L47)
[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L47)
___
@@ -128,7 +128,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L49)
[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L49)
___
@@ -138,7 +138,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L46)
[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L46)
___
@@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L43)
[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L43)
## Methods
@@ -191,7 +191,27 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
### clearLineItemsTaxLines
▸ **clearLineItemsTaxLines**(`itemIds`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `itemIds` | `string`[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L94)
___
@@ -211,7 +231,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L94)
[packages/medusa/src/services/tax-provider.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L104)
___
@@ -237,7 +257,7 @@ the newly created tax lines
#### Defined in
[packages/medusa/src/services/tax-provider.ts:170](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L170)
[packages/medusa/src/services/tax-provider.ts:180](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L180)
___
@@ -262,7 +282,7 @@ the newly created tax lines
#### Defined in
[packages/medusa/src/services/tax-provider.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L116)
[packages/medusa/src/services/tax-provider.ts:126](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L126)
___
@@ -287,7 +307,7 @@ the cached result or null
#### Defined in
[packages/medusa/src/services/tax-provider.ts:457](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L457)
[packages/medusa/src/services/tax-provider.ts:467](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L467)
___
@@ -312,7 +332,7 @@ the cache key to use for the id set
#### Defined in
[packages/medusa/src/services/tax-provider.ts:426](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L426)
[packages/medusa/src/services/tax-provider.ts:436](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L436)
___
@@ -338,7 +358,7 @@ the tax rates configured for the shipping option.
#### Defined in
[packages/medusa/src/services/tax-provider.ts:379](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L379)
[packages/medusa/src/services/tax-provider.ts:389](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L389)
___
@@ -364,7 +384,7 @@ the tax rates configured for the shipping option.
#### Defined in
[packages/medusa/src/services/tax-provider.ts:333](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L333)
[packages/medusa/src/services/tax-provider.ts:343](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L343)
___
@@ -391,7 +411,7 @@ the computed tax lines
#### Defined in
[packages/medusa/src/services/tax-provider.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L191)
[packages/medusa/src/services/tax-provider.ts:201](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L201)
___
@@ -420,7 +440,7 @@ the computed tax lines
#### Defined in
[packages/medusa/src/services/tax-provider.ts:243](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L243)
[packages/medusa/src/services/tax-provider.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L253)
___
@@ -434,7 +454,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L66)
[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L66)
___
@@ -454,7 +474,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-provider.ts:478](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L478)
[packages/medusa/src/services/tax-provider.ts:488](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L488)
___
@@ -478,7 +498,7 @@ the region specific tax provider
#### Defined in
[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L76)
[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L76)
___
@@ -504,7 +524,7 @@ promise that resolves after the cache has been set
#### Defined in
[packages/medusa/src/services/tax-provider.ts:437](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L437)
[packages/medusa/src/services/tax-provider.ts:447](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L447)
___
@@ -528,7 +548,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -552,4 +572,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/TaxRateService.md
+146 -33
View File
@@ -2,7 +2,7 @@
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`
↳ **`TaxRateService`**
@@ -20,61 +20,107 @@
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L28)
[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L31)
## Properties
### manager\_
### \_\_configModule\_\_
• `Private` **manager\_**: `EntityManager`
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/services/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L22)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L23)
___
### productService\_
• `Private` **productService\_**: [`ProductService`](ProductService.md)
• `Protected` `Readonly` **productService\_**: [`ProductService`](ProductService.md)
#### Defined in
[packages/medusa/src/services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L23)
[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L26)
___
### productTypeService\_
• `Private` **productTypeService\_**: [`ProductTypeService`](ProductTypeService.md)
• `Protected` `Readonly` **productTypeService\_**: [`ProductTypeService`](ProductTypeService.md)
#### Defined in
[packages/medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L24)
[packages/medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L27)
___
### shippingOptionService\_
• `Private` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
#### Defined in
[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L25)
[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L28)
___
### taxRateRepository\_
• `Private` **taxRateRepository\_**: typeof `TaxRateRepository`
• `Protected` `Readonly` **taxRateRepository\_**: typeof `TaxRateRepository`
#### Defined in
[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L26)
[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L29)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L24)
## Methods
@@ -96,7 +142,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:197](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L197)
[packages/medusa/src/services/tax-rate.ts:181](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L181)
___
@@ -118,13 +164,13 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:233](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L233)
[packages/medusa/src/services/tax-rate.ts:217](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L217)
___
### addToShippingOption
▸ **addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<`ShippingTaxRate`\>
▸ **addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<`ShippingTaxRate`[]\>
#### Parameters
@@ -136,11 +182,50 @@ ___
#### Returns
`Promise`<`ShippingTaxRate`\>
`Promise`<`ShippingTaxRate`[]\>
#### Defined in
[packages/medusa/src/services/tax-rate.ts:273](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L273)
[packages/medusa/src/services/tax-rate.ts:257](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L257)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -160,7 +245,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L104)
[packages/medusa/src/services/tax-rate.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L88)
___
@@ -180,7 +265,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L135)
[packages/medusa/src/services/tax-rate.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L119)
___
@@ -201,7 +286,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L63)
[packages/medusa/src/services/tax-rate.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L47)
___
@@ -222,7 +307,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L74)
[packages/medusa/src/services/tax-rate.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L58)
___
@@ -243,7 +328,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:321](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L321)
[packages/medusa/src/services/tax-rate.ts:305](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L305)
___
@@ -263,7 +348,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:331](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L331)
[packages/medusa/src/services/tax-rate.ts:315](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L315)
___
@@ -284,7 +369,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:143](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L143)
[packages/medusa/src/services/tax-rate.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L127)
___
@@ -305,7 +390,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:161](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L161)
[packages/medusa/src/services/tax-rate.ts:145](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L145)
___
@@ -326,7 +411,7 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L179)
[packages/medusa/src/services/tax-rate.ts:163](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L163)
___
@@ -347,7 +432,31 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L85)
[packages/medusa/src/services/tax-rate.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L69)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -368,24 +477,28 @@ ___
#### Defined in
[packages/medusa/src/services/tax-rate.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L120)
[packages/medusa/src/services/tax-rate.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L104)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`TaxRateService`](TaxRateService.md)
▸ **withTransaction**(`transactionManager?`): [`TaxRateService`](TaxRateService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `EntityManager` |
| `transactionManager?` | `EntityManager` |
#### Returns
[`TaxRateService`](TaxRateService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/services/tax-rate.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L44)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/TotalsService.md
+37 -35
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L108)
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L108)
## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -66,7 +66,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L106)
[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L106)
___
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L101)
[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L101)
___
@@ -90,7 +90,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L105)
[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L105)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L104)
[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L104)
___
@@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L102)
[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L102)
## Methods
@@ -153,7 +153,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -181,7 +181,7 @@ triples of lineitem, variant and applied discount
#### Defined in
[packages/medusa/src/services/totals.ts:647](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L647)
[packages/medusa/src/services/totals.ts:609](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L609)
___
@@ -210,7 +210,7 @@ array of triples of lineitem, variant and applied discount
#### Defined in
[packages/medusa/src/services/totals.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L689)
[packages/medusa/src/services/totals.ts:651](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L651)
___
@@ -237,7 +237,7 @@ the allocation map for the line items in the cart or order.
#### Defined in
[packages/medusa/src/services/totals.ts:433](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L433)
[packages/medusa/src/services/totals.ts:431](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L431)
___
@@ -262,7 +262,7 @@ the tax calculation context
#### Defined in
[packages/medusa/src/services/totals.ts:1094](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1094)
[packages/medusa/src/services/totals.ts:1065](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L1065)
___
@@ -287,13 +287,13 @@ the total discounts amount
#### Defined in
[packages/medusa/src/services/totals.ts:1064](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1064)
[packages/medusa/src/services/totals.ts:1035](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L1035)
___
### getGiftCardTotal
▸ **getGiftCardTotal**(`cartOrOrder`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\>
▸ **getGiftCardTotal**(`cartOrOrder`, `opts?`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\>
Gets the gift card amount on a cart or order.
@@ -302,6 +302,8 @@ Gets the gift card amount on a cart or order.
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to get gift card amount for |
| `opts` | `Object` | - |
| `opts.gift_cardable?` | `number` | - |
#### Returns
@@ -311,7 +313,7 @@ the gift card amount applied to the cart or order
#### Defined in
[packages/medusa/src/services/totals.ts:989](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L989)
[packages/medusa/src/services/totals.ts:952](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L952)
___
@@ -336,7 +338,7 @@ the gift card amount applied to the cart or order
#### Defined in
[packages/medusa/src/services/totals.ts:972](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L972)
[packages/medusa/src/services/totals.ts:935](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L935)
___
@@ -362,7 +364,7 @@ the allocations that the discount has on the items in the cart or
#### Defined in
[packages/medusa/src/services/totals.ts:740](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L740)
[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L702)
___
@@ -382,7 +384,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:717](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L717)
[packages/medusa/src/services/totals.ts:679](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L679)
___
@@ -403,7 +405,7 @@ ___
#### Defined in
[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L702)
[packages/medusa/src/services/totals.ts:664](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L664)
___
@@ -428,7 +430,7 @@ the line item refund amount.
#### Defined in
[packages/medusa/src/services/totals.ts:525](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L525)
[packages/medusa/src/services/totals.ts:487](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L487)
___
@@ -455,7 +457,7 @@ the line item total
#### Defined in
[packages/medusa/src/services/totals.ts:941](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L941)
[packages/medusa/src/services/totals.ts:908](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L908)
___
@@ -483,7 +485,7 @@ the breakdown of the line item totals
#### Defined in
[packages/medusa/src/services/totals.ts:786](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L786)
[packages/medusa/src/services/totals.ts:748](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L748)
___
@@ -507,7 +509,7 @@ the total paid amount
#### Defined in
[packages/medusa/src/services/totals.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L158)
[packages/medusa/src/services/totals.ts:153](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L153)
___
@@ -534,7 +536,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:604](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L604)
[packages/medusa/src/services/totals.ts:566](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L566)
___
@@ -558,7 +560,7 @@ the total refunded amount for an order.
#### Defined in
[packages/medusa/src/services/totals.ts:510](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L510)
[packages/medusa/src/services/totals.ts:472](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L472)
___
@@ -585,7 +587,7 @@ An object that breaks down the totals for the shipping method
#### Defined in
[packages/medusa/src/services/totals.ts:192](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L192)
[packages/medusa/src/services/totals.ts:187](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L187)
___
@@ -609,7 +611,7 @@ shipping total
#### Defined in
[packages/medusa/src/services/totals.ts:317](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L317)
[packages/medusa/src/services/totals.ts:315](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L315)
___
@@ -634,7 +636,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:281](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L281)
[packages/medusa/src/services/totals.ts:279](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L279)
___
@@ -659,7 +661,7 @@ the swap total
#### Defined in
[packages/medusa/src/services/totals.ts:173](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L173)
[packages/medusa/src/services/totals.ts:168](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L168)
___
@@ -685,7 +687,7 @@ tax total
#### Defined in
[packages/medusa/src/services/totals.ts:344](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L344)
[packages/medusa/src/services/totals.ts:342](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L342)
___
@@ -710,7 +712,7 @@ the calculated subtotal
#### Defined in
[packages/medusa/src/services/totals.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L135)
[packages/medusa/src/services/totals.ts:130](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L130)
___
@@ -734,7 +736,7 @@ the rounded value
#### Defined in
[packages/medusa/src/services/totals.ts:1124](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1124)
[packages/medusa/src/services/totals.ts:1095](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L1095)
___
@@ -758,7 +760,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -782,4 +784,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/classes/UserService.md
+21 -21
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L41)
[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L40)
## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/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/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[packages/medusa/src/services/user.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L39)
[packages/medusa/src/services/user.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L38)
___
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/user.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L36)
[packages/medusa/src/services/user.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L35)
___
@@ -92,7 +92,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/user.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L37)
[packages/medusa/src/services/user.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L36)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/user.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L38)
[packages/medusa/src/services/user.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L37)
___
@@ -121,7 +121,7 @@ ___
#### Defined in
[packages/medusa/src/services/user.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L29)
[packages/medusa/src/services/user.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L28)
## Methods
@@ -160,7 +160,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___
@@ -186,7 +186,7 @@ the result of create
#### Defined in
[packages/medusa/src/services/user.ts:157](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L157)
[packages/medusa/src/services/user.ts:156](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L156)
___
@@ -210,7 +210,7 @@ the result of the delete operation.
#### Defined in
[packages/medusa/src/services/user.ts:237](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L237)
[packages/medusa/src/services/user.ts:236](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L236)
___
@@ -238,7 +238,7 @@ the generated JSON web token
#### Defined in
[packages/medusa/src/services/user.ts:293](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L293)
[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L292)
___
@@ -262,7 +262,7 @@ hashed password
#### Defined in
[packages/medusa/src/services/user.ts:145](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L145)
[packages/medusa/src/services/user.ts:144](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L144)
___
@@ -285,7 +285,7 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/user.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L54)
[packages/medusa/src/services/user.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L53)
___
@@ -311,7 +311,7 @@ the user document.
#### Defined in
[packages/medusa/src/services/user.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L67)
[packages/medusa/src/services/user.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L66)
___
@@ -337,7 +337,7 @@ the user document.
#### Defined in
[packages/medusa/src/services/user.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L91)
[packages/medusa/src/services/user.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L90)
___
@@ -363,7 +363,7 @@ the user document.
#### Defined in
[packages/medusa/src/services/user.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L120)
[packages/medusa/src/services/user.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L119)
___
@@ -390,7 +390,7 @@ the result of the update operation
#### Defined in
[packages/medusa/src/services/user.ts:264](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L264)
[packages/medusa/src/services/user.ts:263](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L263)
___
@@ -414,7 +414,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___
@@ -439,7 +439,7 @@ the result of create
#### Defined in
[packages/medusa/src/services/user.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L191)
[packages/medusa/src/services/user.ts:190](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L190)
___
@@ -463,4 +463,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
docs/content/references/services/index.md
+4
View File
@@ -19,14 +19,18 @@
- [GiftCardService](classes/GiftCardService.md)
- [IdempotencyKeyService](classes/IdempotencyKeyService.md)
- [InventoryService](classes/InventoryService.md)
- [LineItemAdjustmentService](classes/LineItemAdjustmentService.md)
- [LineItemService](classes/LineItemService.md)
- [MiddlewareService](classes/MiddlewareService.md)
- [NoteService](classes/NoteService.md)
- [NotificationService](classes/NotificationService.md)
- [OauthService](classes/OauthService.md)
- [OrderEditItemChangeService](classes/OrderEditItemChangeService.md)
- [OrderEditService](classes/OrderEditService.md)
- [OrderService](classes/OrderService.md)
- [PaymentCollectionService](classes/PaymentCollectionService.md)
- [PaymentProviderService](classes/PaymentProviderService.md)
- [PriceListService](classes/PriceListService.md)
- [PricingService](classes/PricingService.md)
- [ProductCollectionService](classes/ProductCollectionService.md)
- [ProductService](classes/ProductService.md)