chore(docs): Generated Services Reference (automated) (#2891)
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq[bot] authored and 
GitHub committed
1 parent
8cbd627fb7
commit
a32a2c4cf1
56 files changed
+2165
-1675
No files matched your search
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L24)
|
||||
[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L24)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L21)
|
||||
[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L18)
|
||||
[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L19)
|
||||
[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +100,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L22)
|
||||
[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L22)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -139,7 +139,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +162,7 @@ Creates an analytics config.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L56)
|
||||
[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -184,7 +184,7 @@ Deletes an analytics config.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L103)
|
||||
[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L103)
|
||||
|
||||
___
|
||||
|
||||
@@ -204,7 +204,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L32)
|
||||
[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -228,7 +228,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -251,7 +251,7 @@ Updates an analytics config. If the config does not exist, it will be created in
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/analytics-config.ts#L72)
|
||||
[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/analytics-config.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -275,4 +275,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L24)
|
||||
[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L22)
|
||||
[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L19)
|
||||
[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +92,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L20)
|
||||
[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L21)
|
||||
[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L21)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -169,7 +169,7 @@ success: whether authentication succeeded
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L97)
|
||||
[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -195,7 +195,7 @@ success: whether authentication succeeded
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L54)
|
||||
[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -223,7 +223,7 @@ success: whether authentication succeeded
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L146)
|
||||
[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L146)
|
||||
|
||||
___
|
||||
|
||||
@@ -248,7 +248,7 @@ the result of the comparison
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/auth.ts#L38)
|
||||
[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/auth.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -272,7 +272,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -296,4 +296,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L93)
|
||||
[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/batch-job.ts#L41)
|
||||
[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/batch-job.ts#L45)
|
||||
[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/batch-job.ts#L42)
|
||||
[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/batch-job.ts#L38)
|
||||
[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/batch-job.ts#L43)
|
||||
[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/batch-job.ts#L39)
|
||||
[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/batch-job.ts#L27)
|
||||
[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/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:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -202,7 +202,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:269](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L269)
|
||||
[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L277)
|
||||
|
||||
___
|
||||
|
||||
@@ -222,7 +222,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:251](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L251)
|
||||
[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L259)
|
||||
|
||||
___
|
||||
|
||||
@@ -242,7 +242,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:233](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L233)
|
||||
[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L241)
|
||||
|
||||
___
|
||||
|
||||
@@ -262,7 +262,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:138](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L138)
|
||||
[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L146)
|
||||
|
||||
___
|
||||
|
||||
@@ -283,7 +283,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:127](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L127)
|
||||
[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L135)
|
||||
|
||||
___
|
||||
|
||||
@@ -304,7 +304,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:366](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L366)
|
||||
[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L374)
|
||||
|
||||
___
|
||||
|
||||
@@ -325,7 +325,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:107](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L107)
|
||||
[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L108)
|
||||
|
||||
___
|
||||
|
||||
@@ -338,7 +338,7 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batchJobOrId` | `string` \| `BatchJob` |
|
||||
| `error?` | `BatchJobResultError` |
|
||||
| `error?` | `string` \| `BatchJobResultError` |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -346,7 +346,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:340](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L340)
|
||||
[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L348)
|
||||
|
||||
___
|
||||
|
||||
@@ -366,7 +366,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:287](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L287)
|
||||
[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L295)
|
||||
|
||||
___
|
||||
|
||||
@@ -386,7 +386,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:320](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L320)
|
||||
[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L328)
|
||||
|
||||
___
|
||||
|
||||
@@ -410,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -431,7 +431,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:157](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L157)
|
||||
[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L165)
|
||||
|
||||
___
|
||||
|
||||
@@ -452,7 +452,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/batch-job.ts:198](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/batch-job.ts#L198)
|
||||
[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/batch-job.ts#L206)
|
||||
|
||||
___
|
||||
|
||||
@@ -476,4 +476,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -0,0 +1,119 @@
|
||||
# Class: CacheService
|
||||
|
||||
## Implements
|
||||
|
||||
- `ICacheService`
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new CacheService**(`__namedParameters`)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `__namedParameters` | `Object` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cache.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L10)
|
||||
|
||||
## Properties
|
||||
|
||||
### redis\_
|
||||
|
||||
• `Protected` `Readonly` **redis\_**: `Redis`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cache.ts:8](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
### get
|
||||
|
||||
▸ **get**<`T`\>(`cacheKey`): `Promise`<``null`` \| `T`\>
|
||||
|
||||
Retrieve a cached value belonging to the given key.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cacheKey` | `string` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<``null`` \| `T`\>
|
||||
|
||||
#### Implementation of
|
||||
|
||||
ICacheService.get
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cache.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### invalidate
|
||||
|
||||
▸ **invalidate**(`key`): `Promise`<`void`\>
|
||||
|
||||
Invalidate cache for a specific key. a key can be either a specific key or more global such as "ps:*".
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `key` | `string` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
#### Implementation of
|
||||
|
||||
ICacheService.invalidate
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cache.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### set
|
||||
|
||||
▸ **set**(`key`, `data`, `ttl?`): `Promise`<`void`\>
|
||||
|
||||
Set a key/value pair to the cache.
|
||||
It is also possible to manage the ttl through environment variable using CACHE_TTL. If the ttl is 0 it will
|
||||
act like the value should not be cached at all.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Default value |
|
||||
| :------ | :------ | :------ |
|
||||
| `key` | `string` | `undefined` |
|
||||
| `data` | `Record`<`string`, `unknown`\> | `undefined` |
|
||||
| `ttl` | `number` | `DEFAULT_CACHE_TIME` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
#### Implementation of
|
||||
|
||||
ICacheService.set
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cache.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cache.ts#L22)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L129)
|
||||
[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L131)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L105)
|
||||
[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L104)
|
||||
[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L124)
|
||||
[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L126)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L116)
|
||||
[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L118)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L118)
|
||||
[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L120)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L108)
|
||||
[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L110)
|
||||
|
||||
___
|
||||
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L127)
|
||||
[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L129)
|
||||
|
||||
___
|
||||
|
||||
@@ -132,7 +132,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L119)
|
||||
[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
@@ -142,7 +142,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L123)
|
||||
[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L125)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +152,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L126)
|
||||
[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L128)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +162,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L107)
|
||||
[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L109)
|
||||
|
||||
___
|
||||
|
||||
@@ -172,7 +172,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L114)
|
||||
[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -186,7 +186,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L100)
|
||||
[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L102)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L122)
|
||||
[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
@@ -206,7 +206,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L115)
|
||||
[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L117)
|
||||
|
||||
___
|
||||
|
||||
@@ -216,7 +216,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L106)
|
||||
[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L108)
|
||||
|
||||
___
|
||||
|
||||
@@ -226,7 +226,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L125)
|
||||
[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L127)
|
||||
|
||||
___
|
||||
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L110)
|
||||
[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
@@ -246,7 +246,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L109)
|
||||
[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -256,7 +256,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L113)
|
||||
[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
@@ -266,7 +266,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L112)
|
||||
[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L114)
|
||||
|
||||
___
|
||||
|
||||
@@ -276,7 +276,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L103)
|
||||
[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L105)
|
||||
|
||||
___
|
||||
|
||||
@@ -286,7 +286,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L117)
|
||||
[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
@@ -296,7 +296,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L111)
|
||||
[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -306,7 +306,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L120)
|
||||
[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L122)
|
||||
|
||||
___
|
||||
|
||||
@@ -316,7 +316,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L121)
|
||||
[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L123)
|
||||
|
||||
___
|
||||
|
||||
@@ -330,7 +330,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L101)
|
||||
[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L103)
|
||||
|
||||
___
|
||||
|
||||
@@ -348,7 +348,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:94](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L94)
|
||||
[packages/medusa/src/services/cart.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L96)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -358,6 +358,10 @@ ___
|
||||
|
||||
Adds a line item to the cart.
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
Use [addOrUpdateLineItems](CartService.md#addorupdatelineitems) instead.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
@@ -375,7 +379,35 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:587](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L587)
|
||||
[packages/medusa/src/services/cart.ts:613](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L613)
|
||||
|
||||
___
|
||||
|
||||
### addOrUpdateLineItems
|
||||
|
||||
▸ **addOrUpdateLineItems**(`cartId`, `lineItems`, `config?`): `Promise`<`void`\>
|
||||
|
||||
Adds or update one or multiple line items to the cart. It also update all existing items in the cart
|
||||
to have has_shipping to false. Finally, the adjustments will be updated.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| :------ | :------ | :------ | :------ |
|
||||
| `cartId` | `string` | `undefined` | the id of the cart that we will add to |
|
||||
| `lineItems` | `LineItem` \| `LineItem`[] | `undefined` | the line items to add. |
|
||||
| `config` | `Object` | `undefined` | validateSalesChannels - should check if product belongs to the same sales chanel as cart (if cart has associated sales channel) |
|
||||
| `config.validateSalesChannels` | `boolean` | `true` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:719](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L719)
|
||||
|
||||
___
|
||||
|
||||
@@ -405,7 +437,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1642](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1642)
|
||||
[packages/medusa/src/services/cart.ts:1862](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1862)
|
||||
|
||||
___
|
||||
|
||||
@@ -433,7 +465,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:749](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L749)
|
||||
[packages/medusa/src/services/cart.ts:934](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L934)
|
||||
|
||||
___
|
||||
|
||||
@@ -461,7 +493,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1170](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1170)
|
||||
[packages/medusa/src/services/cart.ts:1358](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1358)
|
||||
|
||||
___
|
||||
|
||||
@@ -482,7 +514,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1134](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1134)
|
||||
[packages/medusa/src/services/cart.ts:1322](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1322)
|
||||
|
||||
___
|
||||
|
||||
@@ -521,7 +553,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -550,7 +582,7 @@ the resulting cart
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1316](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1316)
|
||||
[packages/medusa/src/services/cart.ts:1508](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1508)
|
||||
|
||||
___
|
||||
|
||||
@@ -574,13 +606,13 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:305](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L305)
|
||||
[packages/medusa/src/services/cart.ts:314](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L314)
|
||||
|
||||
___
|
||||
|
||||
### createOrFetchUserFromEmail\_
|
||||
### createOrFetchGuestCustomerFromEmail\_
|
||||
|
||||
▸ `Protected` **createOrFetchUserFromEmail_**(`email`): `Promise`<`Customer`\>
|
||||
▸ `Protected` **createOrFetchGuestCustomerFromEmail_**(`email`): `Promise`<`Customer`\>
|
||||
|
||||
Creates or fetches a user based on an email.
|
||||
|
||||
@@ -598,7 +630,7 @@ the resultign customer object
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1019](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1019)
|
||||
[packages/medusa/src/services/cart.ts:1209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1209)
|
||||
|
||||
___
|
||||
|
||||
@@ -618,7 +650,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2049](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2049)
|
||||
[packages/medusa/src/services/cart.ts:2269](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2269)
|
||||
|
||||
___
|
||||
|
||||
@@ -639,7 +671,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2099](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2099)
|
||||
[packages/medusa/src/services/cart.ts:2319](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2319)
|
||||
|
||||
___
|
||||
|
||||
@@ -665,7 +697,7 @@ Use decorateTotals instead
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2271](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2271)
|
||||
[packages/medusa/src/services/cart.ts:2491](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2491)
|
||||
|
||||
___
|
||||
|
||||
@@ -689,7 +721,7 @@ the deleted cart or undefined if the cart was not found.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1964](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1964)
|
||||
[packages/medusa/src/services/cart.ts:2184](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2184)
|
||||
|
||||
___
|
||||
|
||||
@@ -714,7 +746,7 @@ the resulting cart.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1550](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1550)
|
||||
[packages/medusa/src/services/cart.ts:1764](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1764)
|
||||
|
||||
___
|
||||
|
||||
@@ -734,7 +766,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2080](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2080)
|
||||
[packages/medusa/src/services/cart.ts:2300](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2300)
|
||||
|
||||
___
|
||||
|
||||
@@ -760,7 +792,7 @@ custom shipping option
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1750](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1750)
|
||||
[packages/medusa/src/services/cart.ts:1970](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1970)
|
||||
|
||||
___
|
||||
|
||||
@@ -780,7 +812,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2322](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2322)
|
||||
[packages/medusa/src/services/cart.ts:2542](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2542)
|
||||
|
||||
___
|
||||
|
||||
@@ -800,7 +832,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:427](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L427)
|
||||
[packages/medusa/src/services/cart.ts:450](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L450)
|
||||
|
||||
___
|
||||
|
||||
@@ -823,7 +855,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:193](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L193)
|
||||
[packages/medusa/src/services/cart.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L195)
|
||||
|
||||
___
|
||||
|
||||
@@ -848,7 +880,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:965](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L965)
|
||||
[packages/medusa/src/services/cart.ts:1155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1155)
|
||||
|
||||
___
|
||||
|
||||
@@ -868,7 +900,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2193](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2193)
|
||||
[packages/medusa/src/services/cart.ts:2413](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2413)
|
||||
|
||||
___
|
||||
|
||||
@@ -893,7 +925,7 @@ the resulting cart.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1598](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1598)
|
||||
[packages/medusa/src/services/cart.ts:1812](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1812)
|
||||
|
||||
___
|
||||
|
||||
@@ -918,7 +950,7 @@ the resulting cart
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1230](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1230)
|
||||
[packages/medusa/src/services/cart.ts:1418](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1418)
|
||||
|
||||
___
|
||||
|
||||
@@ -943,7 +975,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:459](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L459)
|
||||
[packages/medusa/src/services/cart.ts:482](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L482)
|
||||
|
||||
___
|
||||
|
||||
@@ -969,7 +1001,7 @@ the cart document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:211](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L211)
|
||||
[packages/medusa/src/services/cart.ts:213](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L213)
|
||||
|
||||
___
|
||||
|
||||
@@ -993,7 +1025,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:253](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L253)
|
||||
[packages/medusa/src/services/cart.ts:262](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L262)
|
||||
|
||||
___
|
||||
|
||||
@@ -1015,7 +1047,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:285](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L285)
|
||||
[packages/medusa/src/services/cart.ts:294](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L294)
|
||||
|
||||
___
|
||||
|
||||
@@ -1043,7 +1075,7 @@ resolves to the updated result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2007](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2007)
|
||||
[packages/medusa/src/services/cart.ts:2227](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2227)
|
||||
|
||||
___
|
||||
|
||||
@@ -1068,7 +1100,7 @@ result of update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1391](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1391)
|
||||
[packages/medusa/src/services/cart.ts:1583](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1583)
|
||||
|
||||
___
|
||||
|
||||
@@ -1096,7 +1128,7 @@ the result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1457](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1457)
|
||||
[packages/medusa/src/services/cart.ts:1649](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1649)
|
||||
|
||||
___
|
||||
|
||||
@@ -1122,7 +1154,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1830](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1830)
|
||||
[packages/medusa/src/services/cart.ts:2050](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2050)
|
||||
|
||||
___
|
||||
|
||||
@@ -1146,7 +1178,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -1166,7 +1198,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:2213](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L2213)
|
||||
[packages/medusa/src/services/cart.ts:2433](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L2433)
|
||||
|
||||
___
|
||||
|
||||
@@ -1187,7 +1219,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:792](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L792)
|
||||
[packages/medusa/src/services/cart.ts:977](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L977)
|
||||
|
||||
___
|
||||
|
||||
@@ -1213,7 +1245,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1045](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1045)
|
||||
[packages/medusa/src/services/cart.ts:1235](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1235)
|
||||
|
||||
___
|
||||
|
||||
@@ -1238,7 +1270,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1001](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1001)
|
||||
[packages/medusa/src/services/cart.ts:1191](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1191)
|
||||
|
||||
___
|
||||
|
||||
@@ -1264,7 +1296,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:684](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L684)
|
||||
[packages/medusa/src/services/cart.ts:869](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L869)
|
||||
|
||||
___
|
||||
|
||||
@@ -1289,7 +1321,7 @@ the resulting cart
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1278](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1278)
|
||||
[packages/medusa/src/services/cart.ts:1470](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1470)
|
||||
|
||||
___
|
||||
|
||||
@@ -1315,7 +1347,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1085](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1085)
|
||||
[packages/medusa/src/services/cart.ts:1273](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1273)
|
||||
|
||||
___
|
||||
|
||||
@@ -1337,7 +1369,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:1769](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L1769)
|
||||
[packages/medusa/src/services/cart.ts:1989](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L1989)
|
||||
|
||||
___
|
||||
|
||||
@@ -1353,7 +1385,7 @@ Check if line item's variant belongs to the cart's sales channel.
|
||||
| :------ | :------ | :------ |
|
||||
| `sales_channel_id` | `Object` | the cart for the line item |
|
||||
| `sales_channel_id.sales_channel_id` | ``null`` \| `string` | - |
|
||||
| `lineItem` | `LineItem` | the line item being added |
|
||||
| `lineItem` | `LineItemValidateData` | the line item being added |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -1363,7 +1395,7 @@ a boolean indicating validation result
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:556](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L556)
|
||||
[packages/medusa/src/services/cart.ts:579](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L579)
|
||||
|
||||
___
|
||||
|
||||
@@ -1390,7 +1422,7 @@ boolean representing whether shipping method is validated
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/cart.ts:525](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/cart.ts#L525)
|
||||
[packages/medusa/src/services/cart.ts:548](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/cart.ts#L548)
|
||||
|
||||
___
|
||||
|
||||
@@ -1414,4 +1446,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L30)
|
||||
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L30)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim-item.ts#L25)
|
||||
[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim-item.ts#L23)
|
||||
[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim-item.ts#L24)
|
||||
[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim-item.ts#L22)
|
||||
[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim-item.ts#L21)
|
||||
[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L27)
|
||||
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -130,7 +130,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L28)
|
||||
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim-item.ts#L15)
|
||||
[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L15)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -187,7 +187,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -207,7 +207,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L49)
|
||||
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,13 +230,13 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L214)
|
||||
[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L214)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimItem`\>
|
||||
▸ **retrieve**(`claimItemId`, `config?`): `Promise`<`ClaimItem`\>
|
||||
|
||||
Gets a claim item by id.
|
||||
|
||||
@@ -244,7 +244,7 @@ Gets a claim item by id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of ClaimItem to retrieve |
|
||||
| `claimItemId` | `string` | id of ClaimItem to retrieve |
|
||||
| `config` | `FindConfig`<`ClaimItem`\> | configuration for the find operation |
|
||||
|
||||
#### Returns
|
||||
@@ -255,7 +255,7 @@ the ClaimItem
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L233)
|
||||
[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L233)
|
||||
|
||||
___
|
||||
|
||||
@@ -279,7 +279,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -300,7 +300,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L132)
|
||||
[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L132)
|
||||
|
||||
___
|
||||
|
||||
@@ -324,4 +324,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim.ts#L83)
|
||||
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L66)
|
||||
[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L70)
|
||||
[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L67)
|
||||
[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L71)
|
||||
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L72)
|
||||
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L73)
|
||||
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L74)
|
||||
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L69)
|
||||
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L75)
|
||||
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L63)
|
||||
[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L76)
|
||||
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L77)
|
||||
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L78)
|
||||
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L68)
|
||||
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L79)
|
||||
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L80)
|
||||
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L81)
|
||||
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L64)
|
||||
[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L54)
|
||||
[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L54)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -300,7 +300,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -320,7 +320,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim.ts#L761)
|
||||
[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L609)
|
||||
[packages/medusa/src/services/claim.ts:609](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L213)
|
||||
[packages/medusa/src/services/claim.ts:213](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L463)
|
||||
[packages/medusa/src/services/claim.ts:463](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L681)
|
||||
[packages/medusa/src/services/claim.ts:681](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/claim.ts#L817)
|
||||
[packages/medusa/src/services/claim.ts:817](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L817)
|
||||
|
||||
___
|
||||
|
||||
@@ -459,13 +459,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim.ts#L635)
|
||||
[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L635)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimOrder`\>
|
||||
▸ **retrieve**(`claimId`, `config?`): `Promise`<`ClaimOrder`\>
|
||||
|
||||
Gets an order by id.
|
||||
|
||||
@@ -473,7 +473,7 @@ Gets an order by id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the claim order to retrieve |
|
||||
| `claimId` | `string` | id of the claim order to retrieve |
|
||||
| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings |
|
||||
|
||||
#### Returns
|
||||
@@ -484,7 +484,7 @@ the order document
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim.ts#L837)
|
||||
[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim.ts#L837)
|
||||
|
||||
___
|
||||
|
||||
@@ -508,7 +508,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -529,7 +529,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim.ts#L125)
|
||||
[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/currency.ts#L32)
|
||||
[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/currency.ts#L28)
|
||||
[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/currency.ts#L29)
|
||||
[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/currency.ts#L30)
|
||||
[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/currency.ts#L25)
|
||||
[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/currency.ts#L26)
|
||||
[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/currency.ts#L21)
|
||||
[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L21)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -165,7 +165,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/currency.ts#L81)
|
||||
[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/currency.ts#L50)
|
||||
[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/currency.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -266,7 +266,7 @@ The updated currency
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/currency.ts#L103)
|
||||
[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/custom-shipping-option.ts#L20)
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/custom-shipping-option.ts#L18)
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/custom-shipping-option.ts#L15)
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/custom-shipping-option.ts#L16)
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/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:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -153,7 +153,7 @@ resolves to the creation result
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/custom-shipping-option.ts#L89)
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/d843bc102/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:65](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/custom-shipping-option.ts#L65)
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/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:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/custom-shipping-option.ts#L37)
|
||||
[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/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:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -251,4 +251,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:33](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L33)
|
||||
[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L27)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L30)
|
||||
[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L31)
|
||||
[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L27)
|
||||
[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +100,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L28)
|
||||
[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L22)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -125,7 +125,7 @@ the customer group after insertion
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:92](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L92)
|
||||
[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
@@ -164,7 +164,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:68](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L68)
|
||||
[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
@@ -220,7 +220,7 @@ a promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:156](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L156)
|
||||
[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L158)
|
||||
|
||||
___
|
||||
|
||||
@@ -242,7 +242,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:259](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L259)
|
||||
[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L261)
|
||||
|
||||
___
|
||||
|
||||
@@ -267,7 +267,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:179](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L179)
|
||||
[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L181)
|
||||
|
||||
___
|
||||
|
||||
@@ -292,7 +292,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:197](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L197)
|
||||
[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L199)
|
||||
|
||||
___
|
||||
|
||||
@@ -317,19 +317,19 @@ the customergroup with the provided id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:238](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L238)
|
||||
[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L240)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`CustomerGroup`\>
|
||||
▸ **retrieve**(`customerGroupId`, `config?`): `Promise`<`CustomerGroup`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customerGroupId` | `string` |
|
||||
| `config` | `Object` |
|
||||
|
||||
#### Returns
|
||||
@@ -338,7 +338,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L45)
|
||||
[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -362,7 +362,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -387,7 +387,7 @@ resulting customer group
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer-group.ts:123](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer-group.ts#L123)
|
||||
[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer-group.ts#L125)
|
||||
|
||||
___
|
||||
|
||||
@@ -411,4 +411,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L39)
|
||||
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L27)
|
||||
[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L26)
|
||||
[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L28)
|
||||
[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L30)
|
||||
[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L31)
|
||||
[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L33)
|
||||
[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L33)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -151,7 +151,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:457](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L457)
|
||||
[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L498)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/customer.ts#L158)
|
||||
[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L245)
|
||||
[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L285)
|
||||
|
||||
___
|
||||
|
||||
@@ -259,7 +259,7 @@ the result of the delete operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:505](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L505)
|
||||
[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L546)
|
||||
|
||||
___
|
||||
|
||||
@@ -287,7 +287,7 @@ the generated JSON web token
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L64)
|
||||
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/customer.ts#L232)
|
||||
[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L272)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/customer.ts#L107)
|
||||
[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -357,7 +357,28 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L131)
|
||||
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
### listByEmail
|
||||
|
||||
▸ **listByEmail**(`email`, `config?`): `Promise`<`Customer`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `email` | `string` |
|
||||
| `config` | `FindConfig`<`Customer`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Customer`[]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L228)
|
||||
|
||||
___
|
||||
|
||||
@@ -378,7 +399,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:440](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L440)
|
||||
[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L481)
|
||||
|
||||
___
|
||||
|
||||
@@ -403,7 +424,7 @@ the customer document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L220)
|
||||
[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L253)
|
||||
|
||||
___
|
||||
|
||||
@@ -411,7 +432,9 @@ ___
|
||||
|
||||
▸ **retrieveByEmail**(`email`, `config?`): `Promise`<`Customer`\>
|
||||
|
||||
Gets a customer by email.
|
||||
Gets a registered customer by email.
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -428,7 +451,7 @@ the customer document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L194)
|
||||
[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L195)
|
||||
|
||||
___
|
||||
|
||||
@@ -453,7 +476,49 @@ the customer document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L207)
|
||||
[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L240)
|
||||
|
||||
___
|
||||
|
||||
### retrieveRegisteredByEmail
|
||||
|
||||
▸ **retrieveRegisteredByEmail**(`email`, `config?`): `Promise`<`Customer`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `email` | `string` |
|
||||
| `config` | `FindConfig`<`Customer`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Customer`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L218)
|
||||
|
||||
___
|
||||
|
||||
### retrieveUnregisteredByEmail
|
||||
|
||||
▸ **retrieveUnregisteredByEmail**(`email`, `config?`): `Promise`<`Customer`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `email` | `string` |
|
||||
| `config` | `FindConfig`<`Customer`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Customer`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L209)
|
||||
|
||||
___
|
||||
|
||||
@@ -474,7 +539,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L164)
|
||||
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
@@ -498,7 +563,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -523,7 +588,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L300)
|
||||
[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L341)
|
||||
|
||||
___
|
||||
|
||||
@@ -545,7 +610,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:412](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L412)
|
||||
[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L453)
|
||||
|
||||
___
|
||||
|
||||
@@ -570,7 +635,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/customer.ts:360](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/customer.ts#L360)
|
||||
[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/customer.ts#L401)
|
||||
|
||||
___
|
||||
|
||||
@@ -594,4 +659,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L37)
|
||||
[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L37)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L31)
|
||||
[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L32)
|
||||
[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L34)
|
||||
[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L35)
|
||||
[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L35)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -143,7 +143,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -163,7 +163,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:213](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L213)
|
||||
[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L220)
|
||||
|
||||
___
|
||||
|
||||
@@ -183,7 +183,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:181](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L181)
|
||||
[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L188)
|
||||
|
||||
___
|
||||
|
||||
@@ -204,7 +204,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L49)
|
||||
[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -228,7 +228,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -249,7 +249,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:109](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L109)
|
||||
[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -273,7 +273,7 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -293,4 +293,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount-condition.ts:72](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount-condition.ts#L72)
|
||||
[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount-condition.ts#L79)
|
||||
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L67)
|
||||
[packages/medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L68)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/discount.ts#L54)
|
||||
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L58)
|
||||
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L59)
|
||||
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L53)
|
||||
[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L55)
|
||||
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L64)
|
||||
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L65)
|
||||
[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L56)
|
||||
[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -150,7 +150,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L50)
|
||||
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +160,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L61)
|
||||
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -170,7 +170,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L62)
|
||||
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -180,7 +180,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L63)
|
||||
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +190,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L60)
|
||||
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -204,7 +204,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L51)
|
||||
[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L52)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -229,7 +229,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:472](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L472)
|
||||
[packages/medusa/src/services/discount.ts:487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L487)
|
||||
|
||||
___
|
||||
|
||||
@@ -268,13 +268,13 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### calculateDiscountForLineItem
|
||||
|
||||
▸ **calculateDiscountForLineItem**(`discountId`, `lineItem`, `cart`): `Promise`<`number`\>
|
||||
▸ **calculateDiscountForLineItem**(`discountId`, `lineItem`, `calculationContextData`): `Promise`<`number`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -282,7 +282,7 @@ ___
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `lineItem` | `LineItem` |
|
||||
| `cart` | `Cart` |
|
||||
| `calculationContextData` | `CalculationContextData` |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -290,7 +290,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L573)
|
||||
[packages/medusa/src/services/discount.ts:588](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L588)
|
||||
|
||||
___
|
||||
|
||||
@@ -311,7 +311,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:735](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L735)
|
||||
[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L762)
|
||||
|
||||
___
|
||||
|
||||
@@ -336,7 +336,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:185](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L185)
|
||||
[packages/medusa/src/services/discount.ts:186](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L186)
|
||||
|
||||
___
|
||||
|
||||
@@ -361,7 +361,7 @@ the newly created dynamic code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:400](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L400)
|
||||
[packages/medusa/src/services/discount.ts:415](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L415)
|
||||
|
||||
___
|
||||
|
||||
@@ -385,7 +385,7 @@ the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:532](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L532)
|
||||
[packages/medusa/src/services/discount.ts:547](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L547)
|
||||
|
||||
___
|
||||
|
||||
@@ -410,7 +410,7 @@ the newly created dynamic code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:451](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L451)
|
||||
[packages/medusa/src/services/discount.ts:466](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L466)
|
||||
|
||||
___
|
||||
|
||||
@@ -430,7 +430,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:704](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L704)
|
||||
[packages/medusa/src/services/discount.ts:731](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L731)
|
||||
|
||||
___
|
||||
|
||||
@@ -450,7 +450,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:700](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L700)
|
||||
[packages/medusa/src/services/discount.ts:727](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L727)
|
||||
|
||||
___
|
||||
|
||||
@@ -470,7 +470,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:694](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L694)
|
||||
[packages/medusa/src/services/discount.ts:721](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L721)
|
||||
|
||||
___
|
||||
|
||||
@@ -490,7 +490,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:712](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L712)
|
||||
[packages/medusa/src/services/discount.ts:739](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L739)
|
||||
|
||||
___
|
||||
|
||||
@@ -511,7 +511,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:716](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L716)
|
||||
[packages/medusa/src/services/discount.ts:743](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L743)
|
||||
|
||||
___
|
||||
|
||||
@@ -534,7 +534,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:123](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L123)
|
||||
[packages/medusa/src/services/discount.ts:124](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
@@ -557,7 +557,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:139](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L139)
|
||||
[packages/medusa/src/services/discount.ts:140](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L140)
|
||||
|
||||
___
|
||||
|
||||
@@ -582,7 +582,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:507](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L507)
|
||||
[packages/medusa/src/services/discount.ts:522](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L522)
|
||||
|
||||
___
|
||||
|
||||
@@ -607,7 +607,7 @@ the discount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:244](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L244)
|
||||
[packages/medusa/src/services/discount.ts:252](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L252)
|
||||
|
||||
___
|
||||
|
||||
@@ -632,7 +632,7 @@ the discount document
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:270](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L270)
|
||||
[packages/medusa/src/services/discount.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L285)
|
||||
|
||||
___
|
||||
|
||||
@@ -656,7 +656,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -681,7 +681,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:303](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L303)
|
||||
[packages/medusa/src/services/discount.ts:318](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L318)
|
||||
|
||||
___
|
||||
|
||||
@@ -702,7 +702,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:634](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L634)
|
||||
[packages/medusa/src/services/discount.ts:661](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L661)
|
||||
|
||||
___
|
||||
|
||||
@@ -723,7 +723,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:546](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L546)
|
||||
[packages/medusa/src/services/discount.ts:561](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L561)
|
||||
|
||||
___
|
||||
|
||||
@@ -753,7 +753,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/discount.ts#L105)
|
||||
[packages/medusa/src/services/discount.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/discount.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
@@ -777,4 +777,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L54)
|
||||
[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L54)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L48)
|
||||
[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L52)
|
||||
[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L44)
|
||||
[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L47)
|
||||
[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L49)
|
||||
[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +120,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L41)
|
||||
[packages/medusa/src/services/draft-order.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -130,7 +130,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L46)
|
||||
[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -140,7 +140,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L45)
|
||||
[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -150,7 +150,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L50)
|
||||
[packages/medusa/src/services/draft-order.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +160,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L51)
|
||||
[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -174,7 +174,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L42)
|
||||
[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -191,7 +191,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L36)
|
||||
[packages/medusa/src/services/draft-order.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L36)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -230,7 +230,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -254,7 +254,7 @@ the created draft order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:241](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L241)
|
||||
[packages/medusa/src/services/draft-order.ts:248](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L248)
|
||||
|
||||
___
|
||||
|
||||
@@ -278,7 +278,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:140](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L140)
|
||||
[packages/medusa/src/services/draft-order.ts:147](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L147)
|
||||
|
||||
___
|
||||
|
||||
@@ -303,7 +303,7 @@ list of draft orders
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:218](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L218)
|
||||
[packages/medusa/src/services/draft-order.ts:225](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L225)
|
||||
|
||||
___
|
||||
|
||||
@@ -328,7 +328,7 @@ draft orders
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:164](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L164)
|
||||
[packages/medusa/src/services/draft-order.ts:171](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L171)
|
||||
|
||||
___
|
||||
|
||||
@@ -353,13 +353,13 @@ the created order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:366](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L366)
|
||||
[packages/medusa/src/services/draft-order.ts:372](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L372)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`DraftOrder`\>
|
||||
▸ **retrieve**(`draftOrderId`, `config?`): `Promise`<`DraftOrder`\>
|
||||
|
||||
Retrieves a draft order with the given id.
|
||||
|
||||
@@ -367,7 +367,7 @@ Retrieves a draft order with the given id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the draft order to retrieve |
|
||||
| `draftOrderId` | `string` | id of the draft order to retrieve |
|
||||
| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |
|
||||
|
||||
#### Returns
|
||||
@@ -378,7 +378,7 @@ the draft order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L87)
|
||||
[packages/medusa/src/services/draft-order.ts:87](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
@@ -403,7 +403,7 @@ the draft order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L114)
|
||||
[packages/medusa/src/services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
@@ -427,7 +427,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -453,7 +453,7 @@ the updated draft order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/draft-order.ts:395](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/draft-order.ts#L395)
|
||||
[packages/medusa/src/services/draft-order.ts:401](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/draft-order.ts#L401)
|
||||
|
||||
___
|
||||
|
||||
@@ -477,4 +477,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L47)
|
||||
[packages/medusa/src/services/event-bus.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L48)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -29,27 +29,7 @@ subscribers when events happen. Events will run asynchronously.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### cronHandlers\_
|
||||
|
||||
• `Protected` `Readonly` **cronHandlers\_**: `Map`<`string` \| `symbol`, `Subscriber`<`unknown`\>[]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### cronQueue\_
|
||||
|
||||
• `Protected` `Readonly` **cronQueue\_**: `Bull`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L41)
|
||||
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -59,7 +39,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L45)
|
||||
[packages/medusa/src/services/event-bus.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### jobSchedulerService\_
|
||||
|
||||
• `Protected` `Readonly` **jobSchedulerService\_**: `default`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -69,7 +59,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L35)
|
||||
[packages/medusa/src/services/event-bus.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -79,7 +69,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L34)
|
||||
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -89,7 +79,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L37)
|
||||
[packages/medusa/src/services/event-bus.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -99,7 +89,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L42)
|
||||
[packages/medusa/src/services/event-bus.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -109,7 +99,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L39)
|
||||
[packages/medusa/src/services/event-bus.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -119,7 +109,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L40)
|
||||
[packages/medusa/src/services/event-bus.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -129,7 +119,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L43)
|
||||
[packages/medusa/src/services/event-bus.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -139,7 +129,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L36)
|
||||
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -149,7 +139,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L44)
|
||||
[packages/medusa/src/services/event-bus.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L45)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -159,6 +149,10 @@ ___
|
||||
|
||||
Registers a cron job.
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
All cron job logic has been refactored to the `JobSchedulerService`. This method will be removed in a future release.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
@@ -182,40 +176,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:323](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L323)
|
||||
|
||||
___
|
||||
|
||||
### cronWorker\_
|
||||
|
||||
▸ **cronWorker_**<`T`\>(`job`): `Promise`<`unknown`[]\>
|
||||
|
||||
Handles incoming jobs.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `job` | `Object` | The job object |
|
||||
| `job.data` | `Object` | - |
|
||||
| `job.data.data` | `T` | - |
|
||||
| `job.data.eventName` | `string` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`unknown`[]\>
|
||||
|
||||
resolves to the results of the subscriber calls.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:296](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L296)
|
||||
[packages/medusa/src/services/event-bus.ts:279](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L279)
|
||||
|
||||
___
|
||||
|
||||
@@ -247,7 +208,7 @@ the job from our queue
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:188](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L188)
|
||||
[packages/medusa/src/services/event-bus.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
@@ -261,32 +222,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:230](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L230)
|
||||
|
||||
___
|
||||
|
||||
### registerCronHandler\_
|
||||
|
||||
▸ `Protected` **registerCronHandler_**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
|
||||
|
||||
Adds a function to a list of event subscribers.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `event` | `string` \| `symbol` | the event that the subscriber will listen for. |
|
||||
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`EventBusService`](EventBusService.md)
|
||||
|
||||
this
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:167](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L167)
|
||||
[packages/medusa/src/services/event-bus.ts:209](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L209)
|
||||
|
||||
___
|
||||
|
||||
@@ -300,7 +236,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:220](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L220)
|
||||
[packages/medusa/src/services/event-bus.ts:199](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L199)
|
||||
|
||||
___
|
||||
|
||||
@@ -314,7 +250,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:225](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L225)
|
||||
[packages/medusa/src/services/event-bus.ts:204](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L204)
|
||||
|
||||
___
|
||||
|
||||
@@ -339,7 +275,7 @@ this
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:127](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L127)
|
||||
[packages/medusa/src/services/event-bus.ts:127](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L127)
|
||||
|
||||
___
|
||||
|
||||
@@ -364,7 +300,7 @@ this
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:145](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L145)
|
||||
[packages/medusa/src/services/event-bus.ts:145](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L145)
|
||||
|
||||
___
|
||||
|
||||
@@ -384,7 +320,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:97](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L97)
|
||||
[packages/medusa/src/services/event-bus.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L96)
|
||||
|
||||
___
|
||||
|
||||
@@ -417,4 +353,4 @@ resolves to the results of the subscriber calls.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/event-bus.ts:265](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/event-bus.ts#L265)
|
||||
[packages/medusa/src/services/event-bus.ts:244](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/event-bus.ts#L244)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L42)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L38)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L40)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:35](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L35)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L36)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L41)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -163,7 +163,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:146](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L146)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L151)
|
||||
|
||||
___
|
||||
|
||||
@@ -175,7 +175,7 @@ ___
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `option` | `ShippingOption` |
|
||||
| `option` | `CalculateOptionPriceInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -183,7 +183,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:121](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L121)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L126)
|
||||
|
||||
___
|
||||
|
||||
@@ -203,7 +203,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:139](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L139)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
@@ -226,7 +226,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L106)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -246,7 +246,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L164)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L169)
|
||||
|
||||
___
|
||||
|
||||
@@ -260,7 +260,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:66](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L66)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -280,7 +280,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:74](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L74)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -300,7 +300,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L52)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -326,7 +326,7 @@ document to fetch
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:183](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L183)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L188)
|
||||
|
||||
___
|
||||
|
||||
@@ -348,7 +348,7 @@ the payment fulfillment provider
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:95](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L95)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
@@ -372,7 +372,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -394,7 +394,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L126)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
@@ -414,7 +414,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:159](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment-provider.ts#L159)
|
||||
[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment-provider.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
@@ -438,4 +438,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment.ts#L47)
|
||||
[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L42)
|
||||
[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L43)
|
||||
[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L45)
|
||||
[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L40)
|
||||
[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L36)
|
||||
[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L41)
|
||||
[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L39)
|
||||
[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L44)
|
||||
[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/fulfillment.ts#L37)
|
||||
[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L37)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -191,7 +191,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/fulfillment.ts#L253)
|
||||
[packages/medusa/src/services/fulfillment.ts:260](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L260)
|
||||
|
||||
___
|
||||
|
||||
@@ -246,7 +246,7 @@ the created fulfillments
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:198](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment.ts#L198)
|
||||
[packages/medusa/src/services/fulfillment.ts:205](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L205)
|
||||
|
||||
___
|
||||
|
||||
@@ -273,7 +273,7 @@ the shipped fulfillment
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:303](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment.ts#L303)
|
||||
[packages/medusa/src/services/fulfillment.ts:310](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L310)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/fulfillment.ts#L109)
|
||||
[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L109)
|
||||
|
||||
___
|
||||
|
||||
@@ -319,13 +319,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment.ts#L71)
|
||||
[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`Fulfillment`\>
|
||||
▸ **retrieve**(`fulfillmentId`, `config?`): `Promise`<`Fulfillment`\>
|
||||
|
||||
Retrieves a fulfillment by its id.
|
||||
|
||||
@@ -333,7 +333,7 @@ Retrieves a fulfillment by its id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | the id of the fulfillment to retrieve |
|
||||
| `fulfillmentId` | `string` | the id of the fulfillment to retrieve |
|
||||
| `config` | `FindConfig`<`Fulfillment`\> | optional values to include with fulfillmentRepository query |
|
||||
|
||||
#### Returns
|
||||
@@ -344,7 +344,7 @@ the fulfillment
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/fulfillment.ts#L166)
|
||||
[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/fulfillment.ts#L166)
|
||||
|
||||
___
|
||||
|
||||
@@ -368,7 +368,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/fulfillment.ts#L134)
|
||||
[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L47)
|
||||
[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L38)
|
||||
[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/gift-card.ts#L34)
|
||||
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L36)
|
||||
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L40)
|
||||
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L37)
|
||||
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -122,7 +122,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L41)
|
||||
[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -138,7 +138,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L43)
|
||||
[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/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:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -201,7 +201,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L153)
|
||||
[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
@@ -221,7 +221,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L138)
|
||||
[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/d843bc102/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:283](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L283)
|
||||
[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L322)
|
||||
|
||||
___
|
||||
|
||||
@@ -268,7 +268,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L114)
|
||||
[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/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:85](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L85)
|
||||
[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -316,7 +316,7 @@ the gift card
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:217](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L217)
|
||||
[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L242)
|
||||
|
||||
___
|
||||
|
||||
@@ -337,7 +337,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:224](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L224)
|
||||
[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L256)
|
||||
|
||||
___
|
||||
|
||||
@@ -358,7 +358,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:183](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L183)
|
||||
[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L208)
|
||||
|
||||
___
|
||||
|
||||
@@ -382,7 +382,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -407,7 +407,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:237](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L237)
|
||||
[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L276)
|
||||
|
||||
___
|
||||
|
||||
@@ -431,7 +431,7 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -449,4 +449,30 @@ the generated gift card code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L69)
|
||||
[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### resolveTaxRate
|
||||
|
||||
▸ `Static` `Protected` **resolveTaxRate**(`giftCardTaxRate`, `region`): ``null`` \| `number`
|
||||
|
||||
The tax_rate of the giftcard can depend on whether regions tax gift cards, an input
|
||||
provided by the user or the tax rate. Based on these conditions, tax_rate changes.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `giftCardTaxRate` | ``null`` \| `number` |
|
||||
| `region` | `Region` |
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `number`
|
||||
|
||||
the tax rate for the gift card
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L189)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L25)
|
||||
[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L25)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L23)
|
||||
[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L20)
|
||||
[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L21)
|
||||
[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L21)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -155,7 +155,7 @@ the created idempotency key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L67)
|
||||
[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
@@ -182,7 +182,7 @@ the existing or created idempotency key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L41)
|
||||
[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -206,7 +206,7 @@ result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:109](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L109)
|
||||
[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,7 +230,7 @@ idempotency key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L85)
|
||||
[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -254,7 +254,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -289,7 +289,7 @@ result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/idempotency-key.ts:138](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L138)
|
||||
[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L145)
|
||||
|
||||
___
|
||||
|
||||
@@ -313,7 +313,7 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/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:167](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/idempotency-key.ts#L167)
|
||||
[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/idempotency-key.ts#L174)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/inventory.ts#L18)
|
||||
[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/inventory.ts#L15)
|
||||
[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/inventory.ts#L13)
|
||||
[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/inventory.ts#L16)
|
||||
[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/inventory.ts#L31)
|
||||
[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -154,7 +154,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -181,7 +181,7 @@ true if the inventory covers the quantity
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/inventory.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/inventory.ts#L64)
|
||||
[packages/medusa/src/services/inventory.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/inventory.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -205,7 +205,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -229,4 +229,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L44)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L42)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L41)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L38)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L39)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L34)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -165,7 +165,7 @@ line item adjustment
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:88](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L88)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +190,7 @@ a line item adjustment or undefined if no adjustment was created
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:255](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L255)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:255](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L255)
|
||||
|
||||
___
|
||||
|
||||
@@ -216,7 +216,7 @@ otherwise returns an array of line item adjustments for each line item in the ca
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:283](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L283)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:283](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L283)
|
||||
|
||||
___
|
||||
|
||||
@@ -240,13 +240,13 @@ the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L153)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L155)
|
||||
|
||||
___
|
||||
|
||||
### generateAdjustments
|
||||
|
||||
▸ **generateAdjustments**(`cart`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\>
|
||||
▸ **generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\>
|
||||
|
||||
Creates adjustment for a line item
|
||||
|
||||
@@ -254,7 +254,7 @@ Creates adjustment for a line item
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart` | `Cart` | the cart object holding discounts |
|
||||
| `calculationContextData` | `CalculationContextData` | the calculationContextData 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 |
|
||||
|
||||
@@ -266,7 +266,7 @@ 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/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L182)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:184](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L184)
|
||||
|
||||
___
|
||||
|
||||
@@ -291,13 +291,13 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L136)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`LineItemAdjustment`\>
|
||||
▸ **retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<`LineItemAdjustment`\>
|
||||
|
||||
Retrieves a line item adjustment by id.
|
||||
|
||||
@@ -305,7 +305,7 @@ Retrieves a line item adjustment by id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | the id of the line item adjustment to retrieve |
|
||||
| `lineItemAdjustmentId` | `string` | the id of the line item adjustment to retrieve |
|
||||
| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to retrieve the line item adjustment by |
|
||||
|
||||
#### Returns
|
||||
@@ -316,7 +316,7 @@ the line item adjustment.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L63)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -340,7 +340,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -365,7 +365,7 @@ line item adjustment
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item-adjustment.ts#L105)
|
||||
[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item-adjustment.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -389,4 +389,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L53)
|
||||
[packages/medusa/src/services/line-item.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L60)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L44)
|
||||
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L49)
|
||||
[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L43)
|
||||
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L50)
|
||||
[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L42)
|
||||
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L39)
|
||||
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L47)
|
||||
[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L46)
|
||||
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -146,7 +146,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L45)
|
||||
[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -156,7 +156,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L48)
|
||||
[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -166,7 +166,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L51)
|
||||
[packages/medusa/src/services/line-item.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L40)
|
||||
[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L47)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -283,31 +283,38 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:397](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L397)
|
||||
[packages/medusa/src/services/line-item.ts:488](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L488)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`data`): `Promise`<`LineItem`\>
|
||||
▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\>
|
||||
|
||||
Create a line item
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `LineItem` \| `LineItem`[] |
|
||||
| `TResult` | `T` extends `LineItem` ? `LineItem` : `LineItem`[] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `data` | `Partial`<`LineItem`\> | the line item object to create |
|
||||
| `data` | `T` | the line item object to create |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`LineItem`\>
|
||||
`Promise`<`TResult`\>
|
||||
|
||||
the created line item
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:281](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L281)
|
||||
[packages/medusa/src/services/line-item.ts:369](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L369)
|
||||
|
||||
___
|
||||
|
||||
@@ -333,7 +340,7 @@ the created line items
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:128](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L128)
|
||||
[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L135)
|
||||
|
||||
___
|
||||
|
||||
@@ -366,7 +373,7 @@ a new line item tax line
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:389](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L389)
|
||||
[packages/medusa/src/services/line-item.ts:480](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L480)
|
||||
|
||||
___
|
||||
|
||||
@@ -390,7 +397,7 @@ the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:349](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L349)
|
||||
[packages/medusa/src/services/line-item.ts:440](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L440)
|
||||
|
||||
___
|
||||
|
||||
@@ -414,28 +421,61 @@ the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:368](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L368)
|
||||
[packages/medusa/src/services/line-item.ts:459](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L459)
|
||||
|
||||
___
|
||||
|
||||
### generate
|
||||
|
||||
▸ **generate**(`variantId`, `regionId`, `quantity`, `context?`): `Promise`<`LineItem`\>
|
||||
▸ **generate**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`, `context?`): `Promise`<`TResult`\>
|
||||
|
||||
Generate a single or multiple line item without persisting the data into the db
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `string` \| `GenerateInputData` \| `GenerateInputData`[] |
|
||||
| `TResult` | `T` extends `string` ? `LineItem` : `T` extends `LineItem` ? `LineItem` : `LineItem`[] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `variantId` | `string` |
|
||||
| `regionId` | `string` |
|
||||
| `variantIdOrData` | `string` \| `T` |
|
||||
| `regionIdOrContext` | `T` extends `string` ? `string` : `GenerateLineItemContext` |
|
||||
| `quantity?` | `number` |
|
||||
| `context` | `GenerateLineItemContext` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TResult`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L195)
|
||||
|
||||
___
|
||||
|
||||
### generateLineItem
|
||||
|
||||
▸ `Protected` **generateLineItem**(`variant`, `quantity`, `context`): `Promise`<`LineItem`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `variant` | `Object` |
|
||||
| `variant.id` | `string` |
|
||||
| `variant.product` | `Object` |
|
||||
| `variant.product.discountable` | `boolean` |
|
||||
| `variant.product.is_giftcard` | `boolean` |
|
||||
| `variant.product.thumbnail` | ``null`` \| `string` |
|
||||
| `variant.product.title` | `string` |
|
||||
| `variant.product_id` | `string` |
|
||||
| `variant.title` | `string` |
|
||||
| `quantity` | `number` |
|
||||
| `context` | `Object` |
|
||||
| `context.cart?` | `Cart` |
|
||||
| `context.customer_id?` | `string` |
|
||||
| `context.includes_tax?` | `boolean` |
|
||||
| `context.metadata?` | `Record`<`string`, `unknown`\> |
|
||||
| `context.order_edit_id?` | `string` |
|
||||
| `context.unit_price?` | `number` |
|
||||
| `context` | `GenerateLineItemContext` & { `variantPricing`: `ProductVariantPricing` } |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -443,7 +483,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:181](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L181)
|
||||
[packages/medusa/src/services/line-item.ts:298](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L298)
|
||||
|
||||
___
|
||||
|
||||
@@ -464,7 +504,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:81](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L81)
|
||||
[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -489,7 +529,7 @@ the line item
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L101)
|
||||
[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L108)
|
||||
|
||||
___
|
||||
|
||||
@@ -513,7 +553,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -538,7 +578,36 @@ the updated line item(s)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:300](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/line-item.ts#L300)
|
||||
[packages/medusa/src/services/line-item.ts:397](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L397)
|
||||
|
||||
___
|
||||
|
||||
### validateGenerateArguments
|
||||
|
||||
▸ `Protected` **validateGenerateArguments**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`): `void`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `string` \| `GenerateInputData` \| `GenerateInputData`[] |
|
||||
| `TResult` | `T` extends `string` ? `LineItem` : `T` extends `LineItem` ? `LineItem` : `LineItem`[] |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `variantIdOrData` | `string` \| `T` |
|
||||
| `regionIdOrContext` | `T` extends `string` ? `string` : `GenerateLineItemContext` |
|
||||
| `quantity?` | `number` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/line-item.ts:559](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/line-item.ts#L559)
|
||||
|
||||
___
|
||||
|
||||
@@ -562,4 +631,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -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/105c68929/packages/medusa/src/services/middleware.ts#L22)
|
||||
[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L17)
|
||||
[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L18)
|
||||
[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L19)
|
||||
[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L20)
|
||||
[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L60)
|
||||
[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L79)
|
||||
[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L96)
|
||||
[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L29)
|
||||
[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L34)
|
||||
[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L106)
|
||||
[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L117)
|
||||
[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L123)
|
||||
[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/middleware.ts#L43)
|
||||
[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/middleware.ts#L43)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L61)
|
||||
[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L68)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L58)
|
||||
[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L54)
|
||||
[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L59)
|
||||
[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L57)
|
||||
[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L55)
|
||||
[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L62)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -149,7 +149,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -165,7 +165,7 @@ Calculate and return the gift cards totals
|
||||
| :------ | :------ |
|
||||
| `giftCardableAmount` | `number` |
|
||||
| `__namedParameters` | `Object` |
|
||||
| `__namedParameters.giftCardTransactions?` | { `amount`: `number` ; `is_taxable`: ``null`` \| `boolean` ; `tax_rate`: ``null`` \| `number` }[] |
|
||||
| `__namedParameters.giftCardTransactions?` | `GiftCardTransaction`[] |
|
||||
| `__namedParameters.giftCards?` | `GiftCard`[] |
|
||||
| `__namedParameters.region` | `Region` |
|
||||
|
||||
@@ -175,7 +175,7 @@ Calculate and return the gift cards totals
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:446](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L446)
|
||||
[packages/medusa/src/services/new-totals.ts:455](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L455)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +190,7 @@ Calculate and return the gift cards totals based on their transactions
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `__namedParameters` | `Object` |
|
||||
| `__namedParameters.giftCardTransactions` | { `amount`: `number` ; `is_taxable`: ``null`` \| `boolean` ; `tax_rate`: ``null`` \| `number` }[] |
|
||||
| `__namedParameters.giftCardTransactions` | `GiftCardTransaction`[] |
|
||||
| `__namedParameters.region` | `Object` |
|
||||
| `__namedParameters.region.gift_cards_taxable` | `boolean` |
|
||||
| `__namedParameters.region.tax_rate` | `number` |
|
||||
@@ -206,7 +206,7 @@ Calculate and return the gift cards totals based on their transactions
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:504](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L504)
|
||||
[packages/medusa/src/services/new-totals.ts:534](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L534)
|
||||
|
||||
___
|
||||
|
||||
@@ -236,7 +236,7 @@ Return the amount that can be refund on a line item
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:331](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L331)
|
||||
[packages/medusa/src/services/new-totals.ts:340](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L340)
|
||||
|
||||
___
|
||||
|
||||
@@ -263,7 +263,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:401](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L401)
|
||||
[packages/medusa/src/services/new-totals.ts:410](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L410)
|
||||
|
||||
___
|
||||
|
||||
@@ -289,7 +289,7 @@ Calculate and return the items totals for either the legacy calculation or the n
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:82](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L82)
|
||||
[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
@@ -317,7 +317,7 @@ Calculate and return the legacy calculated totals using the tax rate
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:254](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L254)
|
||||
[packages/medusa/src/services/new-totals.ts:263](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L263)
|
||||
|
||||
___
|
||||
|
||||
@@ -346,7 +346,7 @@ Calculate and return the totals for an item
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:150](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L150)
|
||||
[packages/medusa/src/services/new-totals.ts:158](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L158)
|
||||
|
||||
___
|
||||
|
||||
@@ -373,7 +373,7 @@ Calculate and return the shipping methods totals for either the legacy calculati
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:549](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L549)
|
||||
[packages/medusa/src/services/new-totals.ts:580](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L580)
|
||||
|
||||
___
|
||||
|
||||
@@ -399,7 +399,7 @@ Calculate and return the shipping method totals legacy using teh tax rate
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:707](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L707)
|
||||
[packages/medusa/src/services/new-totals.ts:738](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L738)
|
||||
|
||||
___
|
||||
|
||||
@@ -426,7 +426,7 @@ Calculate and return the shipping method totals
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/new-totals.ts:624](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/new-totals.ts#L624)
|
||||
[packages/medusa/src/services/new-totals.ts:655](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/new-totals.ts#L655)
|
||||
|
||||
___
|
||||
|
||||
@@ -450,7 +450,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -474,4 +474,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/note.ts#L29)
|
||||
[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/note.ts#L27)
|
||||
[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/note.ts#L24)
|
||||
[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/note.ts#L26)
|
||||
[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/note.ts#L25)
|
||||
[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/note.ts#L18)
|
||||
[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L18)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -157,7 +157,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -183,7 +183,7 @@ resolves to the creation result
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/note.ts:96](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/note.ts#L96)
|
||||
[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L103)
|
||||
|
||||
___
|
||||
|
||||
@@ -205,7 +205,7 @@ Deletes a given note
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/note.ts:154](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/note.ts#L154)
|
||||
[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L161)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,13 +230,13 @@ notes related to the given search.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/note.ts:75](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/note.ts#L75)
|
||||
[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`Note`\>
|
||||
▸ **retrieve**(`noteId`, `config?`): `Promise`<`Note`\>
|
||||
|
||||
Retrieves a specific note.
|
||||
|
||||
@@ -244,7 +244,7 @@ Retrieves a specific note.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | the id of the note to retrieve. |
|
||||
| `noteId` | `string` | the id of the note to retrieve. |
|
||||
| `config` | `FindConfig`<`Note`\> | any options needed to query for the result. |
|
||||
|
||||
#### Returns
|
||||
@@ -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/105c68929/packages/medusa/src/services/note.ts#L47)
|
||||
[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -279,7 +279,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -304,7 +304,7 @@ resolves to the updated element
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/note.ts:132](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/note.ts#L132)
|
||||
[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/note.ts#L139)
|
||||
|
||||
___
|
||||
|
||||
@@ -328,4 +328,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L36)
|
||||
[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/notification.ts#L27)
|
||||
[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/notification.ts#L28)
|
||||
[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/notification.ts#L31)
|
||||
[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/notification.ts#L23)
|
||||
[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L34)
|
||||
[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/notification.ts#L32)
|
||||
[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/notification.ts#L26)
|
||||
[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/notification.ts#L24)
|
||||
[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L24)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -179,7 +179,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -206,7 +206,7 @@ the result of notification subscribed
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L174)
|
||||
[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/d843bc102/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:86](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L86)
|
||||
[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/d843bc102/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:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L62)
|
||||
[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/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:70](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L70)
|
||||
[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
@@ -302,7 +302,7 @@ the newly created notification
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L254)
|
||||
[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L254)
|
||||
|
||||
___
|
||||
|
||||
@@ -327,7 +327,7 @@ the notification
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L107)
|
||||
[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -352,7 +352,7 @@ the notification provider
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L155)
|
||||
[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L155)
|
||||
|
||||
___
|
||||
|
||||
@@ -379,7 +379,7 @@ the created notification
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L206)
|
||||
[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/notification.ts#L206)
|
||||
|
||||
___
|
||||
|
||||
@@ -403,7 +403,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -426,7 +426,7 @@ Subscribes a given provider to an event.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/notification.ts#L134)
|
||||
[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L31)
|
||||
[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L27)
|
||||
[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L29)
|
||||
[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L26)
|
||||
[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L19)
|
||||
[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L28)
|
||||
[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L20)
|
||||
[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L21)
|
||||
[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L21)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -176,7 +176,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:81](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L81)
|
||||
[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -218,7 +218,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:115](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L115)
|
||||
[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L122)
|
||||
|
||||
___
|
||||
|
||||
@@ -238,7 +238,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:73](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L73)
|
||||
[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
@@ -258,7 +258,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:149](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L149)
|
||||
[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L156)
|
||||
|
||||
___
|
||||
|
||||
@@ -278,7 +278,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L105)
|
||||
[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
@@ -298,7 +298,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L57)
|
||||
[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/oauth.ts#L41)
|
||||
[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -342,7 +342,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -363,7 +363,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/oauth.ts:94](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/oauth.ts#L94)
|
||||
[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/oauth.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -387,4 +387,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L34)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L34)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L30)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L31)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L26)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L29)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L32)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L27)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -137,7 +137,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L21)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L21)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -176,7 +176,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L86)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -216,7 +216,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L102)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L102)
|
||||
|
||||
___
|
||||
|
||||
@@ -237,7 +237,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L73)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
@@ -258,7 +258,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit-item-change.ts#L51)
|
||||
[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit-item-change.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -282,7 +282,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -306,4 +306,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L65)
|
||||
[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L60)
|
||||
[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L62)
|
||||
[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L59)
|
||||
[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L52)
|
||||
[packages/medusa/src/services/order-edit.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L63)
|
||||
[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L55)
|
||||
[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L57)
|
||||
[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L61)
|
||||
[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -146,7 +146,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L58)
|
||||
[packages/medusa/src/services/order-edit.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +160,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L53)
|
||||
[packages/medusa/src/services/order-edit.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -181,7 +181,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L43)
|
||||
[packages/medusa/src/services/order-edit.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L43)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -202,7 +202,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:547](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L547)
|
||||
[packages/medusa/src/services/order-edit.ts:554](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L554)
|
||||
|
||||
___
|
||||
|
||||
@@ -241,7 +241,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -263,7 +263,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:691](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L691)
|
||||
[packages/medusa/src/services/order-edit.ts:698](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L698)
|
||||
|
||||
___
|
||||
|
||||
@@ -285,7 +285,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:730](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L730)
|
||||
[packages/medusa/src/services/order-edit.ts:737](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L737)
|
||||
|
||||
___
|
||||
|
||||
@@ -307,7 +307,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:207](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L207)
|
||||
[packages/medusa/src/services/order-edit.ts:214](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L214)
|
||||
|
||||
___
|
||||
|
||||
@@ -330,7 +330,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L309)
|
||||
[packages/medusa/src/services/order-edit.ts:316](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L316)
|
||||
|
||||
___
|
||||
|
||||
@@ -350,7 +350,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:533](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L533)
|
||||
[packages/medusa/src/services/order-edit.ts:540](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L540)
|
||||
|
||||
___
|
||||
|
||||
@@ -370,7 +370,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:285](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L285)
|
||||
[packages/medusa/src/services/order-edit.ts:292](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L292)
|
||||
|
||||
___
|
||||
|
||||
@@ -390,7 +390,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:803](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L803)
|
||||
[packages/medusa/src/services/order-edit.ts:810](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L810)
|
||||
|
||||
___
|
||||
|
||||
@@ -411,7 +411,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:619](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L619)
|
||||
[packages/medusa/src/services/order-edit.ts:626](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L626)
|
||||
|
||||
___
|
||||
|
||||
@@ -433,7 +433,7 @@ Compute and return the different totals from the order edit id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:148](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L148)
|
||||
[packages/medusa/src/services/order-edit.ts:155](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L155)
|
||||
|
||||
___
|
||||
|
||||
@@ -454,7 +454,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:136](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L136)
|
||||
[packages/medusa/src/services/order-edit.ts:143](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L143)
|
||||
|
||||
___
|
||||
|
||||
@@ -475,7 +475,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:112](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L112)
|
||||
[packages/medusa/src/services/order-edit.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
@@ -495,7 +495,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:490](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L490)
|
||||
[packages/medusa/src/services/order-edit.ts:497](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L497)
|
||||
|
||||
___
|
||||
|
||||
@@ -516,7 +516,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:433](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L433)
|
||||
[packages/medusa/src/services/order-edit.ts:440](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L440)
|
||||
|
||||
___
|
||||
|
||||
@@ -538,7 +538,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:651](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L651)
|
||||
[packages/medusa/src/services/order-edit.ts:658](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L658)
|
||||
|
||||
___
|
||||
|
||||
@@ -559,7 +559,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:90](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L90)
|
||||
[packages/medusa/src/services/order-edit.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
@@ -580,7 +580,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:782](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L782)
|
||||
[packages/medusa/src/services/order-edit.ts:789](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L789)
|
||||
|
||||
___
|
||||
|
||||
@@ -604,7 +604,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -655,7 +655,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:256](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L256)
|
||||
[packages/medusa/src/services/order-edit.ts:263](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L263)
|
||||
|
||||
___
|
||||
|
||||
@@ -682,7 +682,7 @@ Create or update order edit item change line item and apply the quantity
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:360](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L360)
|
||||
[packages/medusa/src/services/order-edit.ts:367](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L367)
|
||||
|
||||
___
|
||||
|
||||
@@ -706,7 +706,7 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -726,4 +726,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order-edit.ts:849](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order-edit.ts#L849)
|
||||
[packages/medusa/src/services/order-edit.ts:856](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order-edit.ts#L856)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L123)
|
||||
[packages/medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L124)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L116)
|
||||
[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L117)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L115)
|
||||
[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L103)
|
||||
[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +92,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L107)
|
||||
[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L108)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L118)
|
||||
[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L120)
|
||||
[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L121)
|
||||
[packages/medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L122)
|
||||
|
||||
___
|
||||
|
||||
@@ -132,7 +132,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L108)
|
||||
[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L109)
|
||||
|
||||
___
|
||||
|
||||
@@ -142,7 +142,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L109)
|
||||
[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L110)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +152,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L117)
|
||||
[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L118)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +162,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L119)
|
||||
[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L120)
|
||||
|
||||
___
|
||||
|
||||
@@ -172,7 +172,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L110)
|
||||
[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -186,7 +186,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:99](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L99)
|
||||
[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L112)
|
||||
[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -206,7 +206,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:102](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L102)
|
||||
[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L103)
|
||||
|
||||
___
|
||||
|
||||
@@ -216,7 +216,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L104)
|
||||
[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L105)
|
||||
|
||||
___
|
||||
|
||||
@@ -226,7 +226,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L114)
|
||||
[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
@@ -236,7 +236,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L105)
|
||||
[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
@@ -246,7 +246,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L106)
|
||||
[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -256,7 +256,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L113)
|
||||
[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L114)
|
||||
|
||||
___
|
||||
|
||||
@@ -266,7 +266,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L111)
|
||||
[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
@@ -280,7 +280,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L100)
|
||||
[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -311,7 +311,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:80](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L80)
|
||||
[packages/medusa/src/services/order.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L81)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -334,7 +334,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:897](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L897)
|
||||
[packages/medusa/src/services/order.ts:962](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L962)
|
||||
|
||||
___
|
||||
|
||||
@@ -359,7 +359,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1422](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1422)
|
||||
[packages/medusa/src/services/order.ts:1487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1487)
|
||||
|
||||
___
|
||||
|
||||
@@ -398,7 +398,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -424,7 +424,7 @@ result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1049](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1049)
|
||||
[packages/medusa/src/services/order.ts:1114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1114)
|
||||
|
||||
___
|
||||
|
||||
@@ -448,7 +448,7 @@ updated order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1359](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1359)
|
||||
[packages/medusa/src/services/order.ts:1424](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1424)
|
||||
|
||||
___
|
||||
|
||||
@@ -472,7 +472,7 @@ result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1127](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1127)
|
||||
[packages/medusa/src/services/order.ts:1192](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1192)
|
||||
|
||||
___
|
||||
|
||||
@@ -494,7 +494,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:499](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L499)
|
||||
[packages/medusa/src/services/order.ts:508](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L508)
|
||||
|
||||
___
|
||||
|
||||
@@ -518,7 +518,7 @@ resolves to the creation result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:527](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L527)
|
||||
[packages/medusa/src/services/order.ts:536](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L536)
|
||||
|
||||
___
|
||||
|
||||
@@ -549,7 +549,29 @@ result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1232](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1232)
|
||||
[packages/medusa/src/services/order.ts:1297](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1297)
|
||||
|
||||
___
|
||||
|
||||
### createGiftCardsFromLineItem\_
|
||||
|
||||
▸ `Protected` **createGiftCardsFromLineItem_**(`order`, `lineItem`, `manager`): `Promise`<`GiftCard`\>[]
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `order` | `Order` |
|
||||
| `lineItem` | `LineItem` |
|
||||
| `manager` | `EntityManager` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`GiftCard`\>[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:748](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L748)
|
||||
|
||||
___
|
||||
|
||||
@@ -578,7 +600,7 @@ the result of the refund operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1448](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1448)
|
||||
[packages/medusa/src/services/order.ts:1513](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1513)
|
||||
|
||||
___
|
||||
|
||||
@@ -609,13 +631,15 @@ the resulting order following the update.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:737](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L737)
|
||||
[packages/medusa/src/services/order.ts:802](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L802)
|
||||
|
||||
___
|
||||
|
||||
### decorateTotals
|
||||
|
||||
▸ `Protected` **decorateTotals**(`order`, `totalsFieldsOrConfig?`): `Promise`<`Order`\>
|
||||
▸ **decorateTotals**(`order`, `totalsFieldsOrConfig?`): `Promise`<`Order`\>
|
||||
|
||||
Calculate and attach the different total fields on the object
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -630,7 +654,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1610](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1610)
|
||||
[packages/medusa/src/services/order.ts:1713](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1713)
|
||||
|
||||
___
|
||||
|
||||
@@ -651,7 +675,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1497](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1497)
|
||||
[packages/medusa/src/services/order.ts:1579](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1579)
|
||||
|
||||
___
|
||||
|
||||
@@ -677,7 +701,7 @@ the line items generated by the transformer.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1401](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1401)
|
||||
[packages/medusa/src/services/order.ts:1466](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1466)
|
||||
|
||||
___
|
||||
|
||||
@@ -697,7 +721,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1836](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1836)
|
||||
[packages/medusa/src/services/order.ts:1939](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1939)
|
||||
|
||||
___
|
||||
|
||||
@@ -720,7 +744,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:177](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L177)
|
||||
[packages/medusa/src/services/order.ts:178](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L178)
|
||||
|
||||
___
|
||||
|
||||
@@ -743,7 +767,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:194](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L194)
|
||||
[packages/medusa/src/services/order.ts:195](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L195)
|
||||
|
||||
___
|
||||
|
||||
@@ -775,7 +799,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1761](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1761)
|
||||
[packages/medusa/src/services/order.ts:1864](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1864)
|
||||
|
||||
___
|
||||
|
||||
@@ -800,7 +824,7 @@ the order document
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:332](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L332)
|
||||
[packages/medusa/src/services/order.ts:334](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L334)
|
||||
|
||||
___
|
||||
|
||||
@@ -825,7 +849,7 @@ the order document
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:421](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L421)
|
||||
[packages/medusa/src/services/order.ts:430](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L430)
|
||||
|
||||
___
|
||||
|
||||
@@ -850,7 +874,7 @@ the order document
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:462](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L462)
|
||||
[packages/medusa/src/services/order.ts:471](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L471)
|
||||
|
||||
___
|
||||
|
||||
@@ -871,7 +895,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:366](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L366)
|
||||
[packages/medusa/src/services/order.ts:375](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L375)
|
||||
|
||||
___
|
||||
|
||||
@@ -893,7 +917,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:404](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L404)
|
||||
[packages/medusa/src/services/order.ts:413](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L413)
|
||||
|
||||
___
|
||||
|
||||
@@ -917,7 +941,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -943,7 +967,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:257](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L257)
|
||||
[packages/medusa/src/services/order.ts:258](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L258)
|
||||
|
||||
___
|
||||
|
||||
@@ -970,7 +994,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:960](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L960)
|
||||
[packages/medusa/src/services/order.ts:1025](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1025)
|
||||
|
||||
___
|
||||
|
||||
@@ -995,7 +1019,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:825](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L825)
|
||||
[packages/medusa/src/services/order.ts:890](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L890)
|
||||
|
||||
___
|
||||
|
||||
@@ -1020,7 +1044,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:865](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L865)
|
||||
[packages/medusa/src/services/order.ts:930](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L930)
|
||||
|
||||
___
|
||||
|
||||
@@ -1049,7 +1073,7 @@ a line item that has the requested fulfillment quantity
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/order.ts:1199](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/order.ts#L1199)
|
||||
[packages/medusa/src/services/order.ts:1264](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/order.ts#L1264)
|
||||
|
||||
___
|
||||
|
||||
@@ -1073,4 +1097,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L52)
|
||||
[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L51)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L48)
|
||||
[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L46)
|
||||
[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L44)
|
||||
[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L50)
|
||||
[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L47)
|
||||
[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L45)
|
||||
[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -139,7 +139,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L37)
|
||||
[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L36)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -178,28 +178,33 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### authorize
|
||||
### authorizePaymentSessions
|
||||
|
||||
▸ **authorize**(`paymentCollectionId`, `context?`): `Promise`<`PaymentCollection`\>
|
||||
▸ **authorizePaymentSessions**(`paymentCollectionId`, `sessionIds`, `context?`): `Promise`<`PaymentCollection`\>
|
||||
|
||||
Authorizes the payment sessions of a payment collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentCollectionId` | `string` |
|
||||
| `context` | `Record`<`string`, `unknown`\> |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection |
|
||||
| `sessionIds` | `string`[] | array of payment session ids to be authorized |
|
||||
| `context` | `Record`<`string`, `unknown`\> | additional data required by payment providers |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentCollection`\>
|
||||
|
||||
the payment collection and its payment session.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:390](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L390)
|
||||
[packages/medusa/src/services/payment-collection.ts:587](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L587)
|
||||
|
||||
___
|
||||
|
||||
@@ -207,19 +212,23 @@ ___
|
||||
|
||||
▸ **create**(`data`): `Promise`<`PaymentCollection`\>
|
||||
|
||||
Creates a new payment collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `data` | `CreatePaymentCollectionInput` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `data` | `CreatePaymentCollectionInput` | info to create the payment collection |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentCollection`\>
|
||||
|
||||
the payment collection created.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:92](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L92)
|
||||
[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -227,19 +236,23 @@ ___
|
||||
|
||||
▸ **delete**(`paymentCollectionId`): `Promise`<`undefined` \| `PaymentCollection`\>
|
||||
|
||||
Deletes a payment collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentCollectionId` | `string` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection to be removed |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`undefined` \| `PaymentCollection`\>
|
||||
|
||||
the payment collection removed.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:150](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L150)
|
||||
[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L180)
|
||||
|
||||
___
|
||||
|
||||
@@ -252,7 +265,7 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `total` | `number` |
|
||||
| `sessionsInput` | `PaymentCollectionSessionInput`[] |
|
||||
| `sessionsInput` | `PaymentCollectionsSessionsBatchInput`[] |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -260,7 +273,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:188](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L188)
|
||||
[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L218)
|
||||
|
||||
___
|
||||
|
||||
@@ -268,41 +281,49 @@ ___
|
||||
|
||||
▸ **markAsAuthorized**(`paymentCollectionId`): `Promise`<`PaymentCollection`\>
|
||||
|
||||
Marks a payment collection as authorized bypassing the payment flow.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentCollectionId` | `string` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentCollection`\>
|
||||
|
||||
the payment session authorized.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:368](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L368)
|
||||
[packages/medusa/src/services/payment-collection.ts:558](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L558)
|
||||
|
||||
___
|
||||
|
||||
### refreshPaymentSession
|
||||
|
||||
▸ **refreshPaymentSession**(`paymentCollectionId`, `sessionId`, `sessionInput`): `Promise`<`PaymentSession`\>
|
||||
▸ **refreshPaymentSession**(`paymentCollectionId`, `sessionId`, `customerId`): `Promise`<`PaymentSession`\>
|
||||
|
||||
Removes and recreate a payment session of a payment collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentCollectionId` | `string` |
|
||||
| `sessionId` | `string` |
|
||||
| `sessionInput` | `Omit`<`PaymentCollectionSessionInput`, ``"amount"``\> |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection |
|
||||
| `sessionId` | `string` | the id of the payment session to be replaced |
|
||||
| `customerId` | `string` | the id of the customer |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentSession`\>
|
||||
|
||||
the new payment session created.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:293](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L293)
|
||||
[packages/medusa/src/services/payment-collection.ts:468](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L468)
|
||||
|
||||
___
|
||||
|
||||
@@ -310,41 +331,76 @@ ___
|
||||
|
||||
▸ **retrieve**(`paymentCollectionId`, `config?`): `Promise`<`PaymentCollection`\>
|
||||
|
||||
Retrieves a payment collection by id.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentCollectionId` | `string` |
|
||||
| `config` | `FindConfig`<`PaymentCollection`\> |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection |
|
||||
| `config` | `FindConfig`<`PaymentCollection`\> | the config to retrieve the payment collection |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentCollection`\>
|
||||
|
||||
the payment collection.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L69)
|
||||
[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
### setPaymentSessions
|
||||
### setPaymentSession
|
||||
|
||||
▸ **setPaymentSessions**(`paymentCollectionId`, `sessions`): `Promise`<`PaymentCollection`\>
|
||||
▸ **setPaymentSession**(`paymentCollectionId`, `sessionInput`, `customerId`): `Promise`<`PaymentCollection`\>
|
||||
|
||||
Manages a single payment sessions of a payment collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentCollectionId` | `string` |
|
||||
| `sessions` | `PaymentCollectionSessionInput` \| `PaymentCollectionSessionInput`[] |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection |
|
||||
| `sessionInput` | `PaymentCollectionsSessionsInput` | object containing payment session info |
|
||||
| `customerId` | `string` | the id of the customer |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentCollection`\>
|
||||
|
||||
the payment collection and its payment session.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:196](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L196)
|
||||
[packages/medusa/src/services/payment-collection.ts:360](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L360)
|
||||
|
||||
___
|
||||
|
||||
### setPaymentSessionsBatch
|
||||
|
||||
▸ **setPaymentSessionsBatch**(`paymentCollectionId`, `sessionsInput`, `customerId`): `Promise`<`PaymentCollection`\>
|
||||
|
||||
Manages multiple payment sessions of a payment collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection |
|
||||
| `sessionsInput` | `PaymentCollectionsSessionsBatchInput`[] | array containing payment session info |
|
||||
| `customerId` | `string` | the id of the customer |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentCollection`\>
|
||||
|
||||
the payment collection and its payment sessions.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L233)
|
||||
|
||||
___
|
||||
|
||||
@@ -368,7 +424,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -376,37 +432,41 @@ ___
|
||||
|
||||
▸ **update**(`paymentCollectionId`, `data`): `Promise`<`PaymentCollection`\>
|
||||
|
||||
Updates a payment collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentCollectionId` | `string` |
|
||||
| `data` | `Object` |
|
||||
| `data.amount?` | `number` |
|
||||
| `data.authorized_amount?` | ``null`` \| `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?` | ``null`` \| `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.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; } |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentCollectionId` | `string` | the id of the payment collection to update |
|
||||
| `data` | `Object` | info to be updated |
|
||||
| `data.amount?` | `number` | - |
|
||||
| `data.authorized_amount?` | ``null`` \| `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?` | ``null`` \| `string` | - |
|
||||
| `data.id?` | `string` | - |
|
||||
| `data.metadata?` | { [x: string]: unknown; } | - |
|
||||
| `data.payment_sessions?` | (`undefined` \| { cart\_id?: string \| null \| 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...)[] | - |
|
||||
| `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.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`\>
|
||||
|
||||
the payment collection updated.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-collection.ts:121](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-collection.ts#L121)
|
||||
[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-collection.ts#L146)
|
||||
|
||||
___
|
||||
|
||||
@@ -430,4 +490,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L57)
|
||||
[packages/medusa/src/services/payment-provider.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L65)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L47)
|
||||
[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
### customerService\_
|
||||
|
||||
• `Protected` `Readonly` **customerService\_**: [`CustomerService`](CustomerService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L55)
|
||||
[packages/medusa/src/services/payment-provider.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L53)
|
||||
[packages/medusa/src/services/payment-provider.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +108,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L45)
|
||||
[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L50)
|
||||
[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L51)
|
||||
[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +138,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L48)
|
||||
[packages/medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -138,7 +148,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L52)
|
||||
[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +162,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L46)
|
||||
[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L53)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -191,7 +201,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -212,7 +222,29 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:447](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L447)
|
||||
[packages/medusa/src/services/payment-provider.ts:394](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L394)
|
||||
|
||||
___
|
||||
|
||||
### buildPaymentContext
|
||||
|
||||
▸ `Protected` **buildPaymentContext**(`cartOrData`): `Cart` & `PaymentContext`
|
||||
|
||||
Build the create session context for both legacy and new API
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cartOrData` | `Cart` \| `PaymentSessionInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Cart` & `PaymentContext`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:643](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L643)
|
||||
|
||||
___
|
||||
|
||||
@@ -232,7 +264,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:503](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L503)
|
||||
[packages/medusa/src/services/payment-provider.ts:450](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L450)
|
||||
|
||||
___
|
||||
|
||||
@@ -252,7 +284,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:528](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L528)
|
||||
[packages/medusa/src/services/payment-provider.ts:475](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L475)
|
||||
|
||||
___
|
||||
|
||||
@@ -264,11 +296,7 @@ ___
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `data` | `Object` |
|
||||
| `data.amount` | `number` |
|
||||
| `data.cart_id` | `string` |
|
||||
| `data.currency_code` | `string` |
|
||||
| `data.payment_session` | `PaymentSession` |
|
||||
| `data` | `CreatePaymentInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -276,42 +304,28 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:381](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L381)
|
||||
|
||||
___
|
||||
|
||||
### createPaymentNew
|
||||
|
||||
▸ **createPaymentNew**(`paymentInput`): `Promise`<`Payment`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentInput` | `Omit`<`PaymentProviderDataInput`, ``"customer"``\> & { `payment_session`: `PaymentSession` } |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Payment`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:411](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L411)
|
||||
[packages/medusa/src/services/payment-provider.ts:356](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L356)
|
||||
|
||||
___
|
||||
|
||||
### createSession
|
||||
|
||||
▸ **createSession**(`providerId`, `cart`): `Promise`<`PaymentSession`\>
|
||||
▸ **createSession**<`TInput`\>(`providerIdOrSessionInput`, ...`cart`): `Promise`<`PaymentSession`\>
|
||||
|
||||
Creates a payment session with the given provider.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `TInput` | extends `string` \| `PaymentSessionInput` = `string` \| `PaymentSessionInput` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `providerId` | `string` | the id of the provider to create payment with |
|
||||
| `cart` | `Cart` | a cart object used to calculate the amount, etc. from |
|
||||
| `providerIdOrSessionInput` | `TInput` | the id of the provider to create payment with or the input data |
|
||||
| `...cart` | `TInput` extends `string` ? [`Cart`] : [undefined?] | a cart object used to calculate the amount, etc. from |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -321,27 +335,7 @@ the payment session
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:172](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L172)
|
||||
|
||||
___
|
||||
|
||||
### createSessionNew
|
||||
|
||||
▸ **createSessionNew**(`sessionInput`): `Promise`<`PaymentSession`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `sessionInput` | `PaymentProviderDataInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentSession`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:195](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L195)
|
||||
[packages/medusa/src/services/payment-provider.ts:181](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L181)
|
||||
|
||||
___
|
||||
|
||||
@@ -361,7 +355,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:327](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L327)
|
||||
[packages/medusa/src/services/payment-provider.ts:302](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L302)
|
||||
|
||||
___
|
||||
|
||||
@@ -381,7 +375,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:523](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L523)
|
||||
[packages/medusa/src/services/payment-provider.ts:470](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L470)
|
||||
|
||||
___
|
||||
|
||||
@@ -395,7 +389,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:89](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L89)
|
||||
[packages/medusa/src/services/payment-provider.ts:98](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
@@ -416,13 +410,38 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:124](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L124)
|
||||
[packages/medusa/src/services/payment-provider.ts:133](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
### processUpdateRequestsData
|
||||
|
||||
▸ `Protected` **processUpdateRequestsData**(`data?`, `paymentResponse`): `Promise`<`void`\>
|
||||
|
||||
Process the collected data. Can be used every time we need to process some collected data returned by the provider
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `data` | `Object` |
|
||||
| `data.customer?` | `Object` |
|
||||
| `data.customer.id?` | `string` |
|
||||
| `paymentResponse` | `Record`<`string`, `unknown`\> \| `PaymentSessionResponse` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:736](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L736)
|
||||
|
||||
___
|
||||
|
||||
### refreshSession
|
||||
|
||||
▸ **refreshSession**(`paymentSession`, `cart`): `Promise`<`PaymentSession`\>
|
||||
▸ **refreshSession**(`paymentSession`, `sessionInput`): `Promise`<`PaymentSession`\>
|
||||
|
||||
Refreshes a payment session with the given provider.
|
||||
This means, that we delete the current one and create a new.
|
||||
@@ -431,8 +450,11 @@ This means, that we delete the current one and create a new.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentSession` | `PaymentSession` | the payment session object to update |
|
||||
| `cart` | `Cart` | a cart object used to calculate the amount, etc. from |
|
||||
| `paymentSession` | `Object` | the payment session object to update |
|
||||
| `paymentSession.data` | `Record`<`string`, `unknown`\> | - |
|
||||
| `paymentSession.id` | `string` | - |
|
||||
| `paymentSession.provider_id` | `string` | - |
|
||||
| `sessionInput` | `PaymentSessionInput` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -442,28 +464,7 @@ the payment session
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:228](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L228)
|
||||
|
||||
___
|
||||
|
||||
### refreshSessionNew
|
||||
|
||||
▸ **refreshSessionNew**(`paymentSession`, `sessionInput`): `Promise`<`PaymentSession`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentSession` | `PaymentSession` |
|
||||
| `sessionInput` | `PaymentProviderDataInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentSession`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:260](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L260)
|
||||
[packages/medusa/src/services/payment-provider.ts:241](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L241)
|
||||
|
||||
___
|
||||
|
||||
@@ -486,7 +487,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:632](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L632)
|
||||
[packages/medusa/src/services/payment-provider.ts:580](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L580)
|
||||
|
||||
___
|
||||
|
||||
@@ -509,7 +510,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:548](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L548)
|
||||
[packages/medusa/src/services/payment-provider.ts:495](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L495)
|
||||
|
||||
___
|
||||
|
||||
@@ -529,7 +530,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:70](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L70)
|
||||
[packages/medusa/src/services/payment-provider.ts:79](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -550,7 +551,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:96](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L96)
|
||||
[packages/medusa/src/services/payment-provider.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L105)
|
||||
|
||||
___
|
||||
|
||||
@@ -580,7 +581,7 @@ the payment provider
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:357](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L357)
|
||||
[packages/medusa/src/services/payment-provider.ts:332](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L332)
|
||||
|
||||
___
|
||||
|
||||
@@ -601,7 +602,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:672](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L672)
|
||||
[packages/medusa/src/services/payment-provider.ts:620](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L620)
|
||||
|
||||
___
|
||||
|
||||
@@ -622,7 +623,36 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:137](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L137)
|
||||
[packages/medusa/src/services/payment-provider.ts:146](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L146)
|
||||
|
||||
___
|
||||
|
||||
### saveSession
|
||||
|
||||
▸ `Protected` **saveSession**(`providerId`, `data`): `Promise`<`PaymentSession`\>
|
||||
|
||||
Create or update a Payment session data.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `providerId` | `string` |
|
||||
| `data` | `Object` |
|
||||
| `data.amount?` | `number` |
|
||||
| `data.cartId?` | `string` |
|
||||
| `data.isSelected?` | `boolean` |
|
||||
| `data.payment_session_id?` | `string` |
|
||||
| `data.sessionData` | `Record`<`string`, `unknown`\> |
|
||||
| `data.status?` | `PaymentSessionStatus` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentSession`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:682](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L682)
|
||||
|
||||
___
|
||||
|
||||
@@ -646,7 +676,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -669,32 +699,35 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:435](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L435)
|
||||
[packages/medusa/src/services/payment-provider.ts:382](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L382)
|
||||
|
||||
___
|
||||
|
||||
### updateSession
|
||||
|
||||
▸ **updateSession**(`paymentSession`, `cart`): `Promise`<`PaymentSession`\>
|
||||
▸ **updateSession**(`paymentSession`, `sessionInput`): `Promise`<`PaymentSession`\>
|
||||
|
||||
Updates an existing payment session.
|
||||
Update a payment session with the given provider.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentSession` | `PaymentSession` | the payment session object to update |
|
||||
| `cart` | `Cart` | the cart object to update for |
|
||||
| `paymentSession` | `Object` | The paymentSession to update |
|
||||
| `paymentSession.data` | `Record`<`string`, `unknown`\> | - |
|
||||
| `paymentSession.id` | `string` | - |
|
||||
| `paymentSession.provider_id` | `string` | - |
|
||||
| `sessionInput` | `Cart` \| `PaymentSessionInput` | |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentSession`\>
|
||||
|
||||
the updated payment session
|
||||
the payment session
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:287](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L287)
|
||||
[packages/medusa/src/services/payment-provider.ts:271](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L271)
|
||||
|
||||
___
|
||||
|
||||
@@ -715,28 +748,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:482](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L482)
|
||||
|
||||
___
|
||||
|
||||
### updateSessionNew
|
||||
|
||||
▸ **updateSessionNew**(`paymentSession`, `sessionInput`): `Promise`<`PaymentSession`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentSession` | `PaymentSession` |
|
||||
| `sessionInput` | `PaymentProviderDataInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`PaymentSession`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment-provider.ts:305](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment-provider.ts#L305)
|
||||
[packages/medusa/src/services/payment-provider.ts:429](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment-provider.ts#L429)
|
||||
|
||||
___
|
||||
|
||||
@@ -760,4 +772,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L40)
|
||||
[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L40)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L28)
|
||||
[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L26)
|
||||
[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L29)
|
||||
[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L30)
|
||||
[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L27)
|
||||
[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -131,7 +131,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L31)
|
||||
[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L31)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -170,7 +170,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -178,19 +178,23 @@ ___
|
||||
|
||||
▸ **capture**(`paymentOrId`): `Promise`<`Payment`\>
|
||||
|
||||
Captures a payment.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentOrId` | `string` \| `Payment` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentOrId` | `string` \| `Payment` | the id or the class instance of the payment |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Payment`\>
|
||||
|
||||
the payment captured.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:132](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L132)
|
||||
[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L161)
|
||||
|
||||
___
|
||||
|
||||
@@ -198,19 +202,23 @@ ___
|
||||
|
||||
▸ **create**(`paymentInput`): `Promise`<`Payment`\>
|
||||
|
||||
Created a new payment.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentInput` | `PaymentDataInput` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentInput` | `PaymentDataInput` | info to create the payment |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Payment`\>
|
||||
|
||||
the payment created.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:78](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L78)
|
||||
[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L96)
|
||||
|
||||
___
|
||||
|
||||
@@ -218,22 +226,26 @@ ___
|
||||
|
||||
▸ **refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<`Refund`\>
|
||||
|
||||
refunds a payment.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentOrId` | `string` \| `Payment` |
|
||||
| `amount` | `number` |
|
||||
| `reason` | `string` |
|
||||
| `note?` | `string` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentOrId` | `string` \| `Payment` | the id or the class instance of the payment |
|
||||
| `amount` | `number` | the amount to be refunded from the payment |
|
||||
| `reason` | `string` | the refund reason |
|
||||
| `note?` | `string` | additional note of the refund |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Refund`\>
|
||||
|
||||
the refund created.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:173](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L173)
|
||||
[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L210)
|
||||
|
||||
___
|
||||
|
||||
@@ -241,20 +253,24 @@ ___
|
||||
|
||||
▸ **retrieve**(`paymentId`, `config?`): `Promise`<`Payment`\>
|
||||
|
||||
Retrieves a payment by id.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentId` | `string` |
|
||||
| `config` | `FindConfig`<`Payment`\> |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentId` | `string` | the id of the payment |
|
||||
| `config` | `FindConfig`<`Payment`\> | the config to retrieve the payment |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Payment`\>
|
||||
|
||||
the payment.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L55)
|
||||
[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -278,7 +294,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -286,22 +302,26 @@ ___
|
||||
|
||||
▸ **update**(`paymentId`, `data`): `Promise`<`Payment`\>
|
||||
|
||||
Updates a payment in order to link it to an order or a swap.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `paymentId` | `string` |
|
||||
| `data` | `Object` |
|
||||
| `data.order_id?` | `string` |
|
||||
| `data.swap_id?` | `string` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `paymentId` | `string` | the id of the payment |
|
||||
| `data` | `Object` | order_id or swap_id to link the payment |
|
||||
| `data.order_id?` | `string` | - |
|
||||
| `data.swap_id?` | `string` | - |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Payment`\>
|
||||
|
||||
the payment updated.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/payment.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/payment.ts#L103)
|
||||
[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/payment.ts#L127)
|
||||
|
||||
___
|
||||
|
||||
@@ -325,4 +345,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L57)
|
||||
[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L57)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L48)
|
||||
[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L55)
|
||||
[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L45)
|
||||
[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L53)
|
||||
[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L52)
|
||||
[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L50)
|
||||
[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L54)
|
||||
[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -138,7 +138,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L49)
|
||||
[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L46)
|
||||
[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +162,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L51)
|
||||
[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L51)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -176,7 +176,7 @@ Add `currency_code` to an MA record if `region_id`is passed.
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends `PriceListPriceUpdateInput` \| `PriceListPriceCreateInput` |
|
||||
| `T` | extends `PriceListPriceCreateInput` \| `PriceListPriceUpdateInput` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -192,7 +192,7 @@ updated `prices` list
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:512](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L512)
|
||||
[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L519)
|
||||
|
||||
___
|
||||
|
||||
@@ -218,7 +218,7 @@ updated Price List
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:211](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L211)
|
||||
[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L218)
|
||||
|
||||
___
|
||||
|
||||
@@ -257,7 +257,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -281,7 +281,7 @@ updated Price List
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:251](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L251)
|
||||
[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L258)
|
||||
|
||||
___
|
||||
|
||||
@@ -305,7 +305,7 @@ created Price List
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:112](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L112)
|
||||
[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
@@ -330,7 +330,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:265](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L265)
|
||||
[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L272)
|
||||
|
||||
___
|
||||
|
||||
@@ -355,7 +355,7 @@ updated Price List
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:236](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L236)
|
||||
[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L243)
|
||||
|
||||
___
|
||||
|
||||
@@ -376,7 +376,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:439](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L439)
|
||||
[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L446)
|
||||
|
||||
___
|
||||
|
||||
@@ -397,7 +397,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:476](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L476)
|
||||
[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L483)
|
||||
|
||||
___
|
||||
|
||||
@@ -422,7 +422,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:285](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L285)
|
||||
[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L292)
|
||||
|
||||
___
|
||||
|
||||
@@ -447,7 +447,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:309](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L309)
|
||||
[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L316)
|
||||
|
||||
___
|
||||
|
||||
@@ -470,7 +470,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:357](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L357)
|
||||
[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L364)
|
||||
|
||||
___
|
||||
|
||||
@@ -493,7 +493,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:405](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L405)
|
||||
[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L412)
|
||||
|
||||
___
|
||||
|
||||
@@ -518,7 +518,7 @@ the collection.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L88)
|
||||
[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -542,7 +542,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -567,7 +567,7 @@ updated Price List
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:160](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L160)
|
||||
[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
@@ -588,7 +588,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/price-list.ts:338](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/price-list.ts#L338)
|
||||
[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/price-list.ts#L345)
|
||||
|
||||
___
|
||||
|
||||
@@ -612,4 +612,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L44)
|
||||
[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L42)
|
||||
[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L36)
|
||||
[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L40)
|
||||
[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L41)
|
||||
[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L38)
|
||||
[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L39)
|
||||
[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -132,7 +132,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L37)
|
||||
[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L37)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ The tax related variant prices.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L104)
|
||||
[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L105)
|
||||
|
||||
___
|
||||
|
||||
@@ -221,7 +221,7 @@ The pricing context
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L69)
|
||||
[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/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:323](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L323)
|
||||
[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L389)
|
||||
|
||||
___
|
||||
|
||||
@@ -272,7 +272,7 @@ A map of variant ids to their corresponding prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:341](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L341)
|
||||
[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L407)
|
||||
|
||||
___
|
||||
|
||||
@@ -294,7 +294,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:285](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L285)
|
||||
[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L351)
|
||||
|
||||
___
|
||||
|
||||
@@ -319,7 +319,7 @@ The product variant prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:213](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L213)
|
||||
[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L214)
|
||||
|
||||
___
|
||||
|
||||
@@ -329,6 +329,10 @@ ___
|
||||
|
||||
Gets the prices for a product variant by a variant id.
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
Use [getProductVariantsPricing](PricingService.md#getproductvariantspricing) instead.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
@@ -344,7 +348,7 @@ The product variant prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:251](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L251)
|
||||
[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L253)
|
||||
|
||||
___
|
||||
|
||||
@@ -366,7 +370,39 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:166](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L166)
|
||||
[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantsPricing
|
||||
|
||||
▸ **getProductVariantsPricing**<`T`, `TOutput`\>(`variantIds`, `context`): `Promise`<`TOutput`\>
|
||||
|
||||
Gets the prices for a collection of variants.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `string` \| `string`[] |
|
||||
| `TOutput` | `T` extends `string` ? `ProductVariantPricing` : { `[variant_id: string]`: `ProductVariantPricing`; } |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `variantIds` | `T` | the id of the variants to get the prices for |
|
||||
| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TOutput`\>
|
||||
|
||||
The product variant prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L294)
|
||||
|
||||
___
|
||||
|
||||
@@ -391,7 +427,7 @@ The shipping option prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:427](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L427)
|
||||
[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L493)
|
||||
|
||||
___
|
||||
|
||||
@@ -416,7 +452,7 @@ A list of products with variants decorated with prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:384](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L384)
|
||||
[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L450)
|
||||
|
||||
___
|
||||
|
||||
@@ -441,7 +477,7 @@ A list of shipping options with prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:489](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L489)
|
||||
[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L555)
|
||||
|
||||
___
|
||||
|
||||
@@ -466,7 +502,7 @@ A list of products with variants decorated with prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/pricing.ts:359](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/pricing.ts#L359)
|
||||
[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/pricing.ts#L425)
|
||||
|
||||
___
|
||||
|
||||
@@ -490,7 +526,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -514,4 +550,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L34)
|
||||
[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L34)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L29)
|
||||
[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L26)
|
||||
[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L31)
|
||||
[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L32)
|
||||
[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L27)
|
||||
[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L27)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -133,7 +133,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:174](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L174)
|
||||
[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L181)
|
||||
|
||||
___
|
||||
|
||||
@@ -172,7 +172,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -196,7 +196,7 @@ created collection
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:107](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L107)
|
||||
[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L114)
|
||||
|
||||
___
|
||||
|
||||
@@ -220,7 +220,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:156](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L156)
|
||||
[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L163)
|
||||
|
||||
___
|
||||
|
||||
@@ -247,7 +247,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:212](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L212)
|
||||
[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L219)
|
||||
|
||||
___
|
||||
|
||||
@@ -272,7 +272,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:229](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L229)
|
||||
[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L236)
|
||||
|
||||
___
|
||||
|
||||
@@ -293,7 +293,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:191](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L191)
|
||||
[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L198)
|
||||
|
||||
___
|
||||
|
||||
@@ -318,7 +318,7 @@ the collection.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L54)
|
||||
[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -343,7 +343,7 @@ the collection.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:81](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L81)
|
||||
[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
@@ -367,7 +367,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -392,7 +392,7 @@ update collection
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-collection.ts:126](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-collection.ts#L126)
|
||||
[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-collection.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
@@ -416,4 +416,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L73)
|
||||
[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L63)
|
||||
[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L64)
|
||||
[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L60)
|
||||
[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L52)
|
||||
[packages/medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L55)
|
||||
[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L56)
|
||||
[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L59)
|
||||
[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L58)
|
||||
[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L57)
|
||||
[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L61)
|
||||
[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L62)
|
||||
[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L53)
|
||||
[packages/medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L67)
|
||||
[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/product.ts#L66)
|
||||
[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/d843bc102/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:619](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L619)
|
||||
[packages/medusa/src/services/product.ts:663](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L663)
|
||||
|
||||
___
|
||||
|
||||
@@ -274,7 +274,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -298,7 +298,7 @@ the result of the count operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:164](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L164)
|
||||
[packages/medusa/src/services/product.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
@@ -322,7 +322,7 @@ resolves to the creation result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:332](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L332)
|
||||
[packages/medusa/src/services/product.ts:376](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L376)
|
||||
|
||||
___
|
||||
|
||||
@@ -347,7 +347,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:585](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L585)
|
||||
[packages/medusa/src/services/product.ts:629](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L629)
|
||||
|
||||
___
|
||||
|
||||
@@ -372,7 +372,7 @@ the updated product
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:784](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L784)
|
||||
[packages/medusa/src/services/product.ts:828](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L828)
|
||||
|
||||
___
|
||||
|
||||
@@ -394,7 +394,30 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:278](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L278)
|
||||
[packages/medusa/src/services/product.ts:299](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L299)
|
||||
|
||||
___
|
||||
|
||||
### isProductInSalesChannels
|
||||
|
||||
▸ **isProductInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\>
|
||||
|
||||
Check if the product is assigned to at least one of the provided sales channels.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | product id |
|
||||
| `salesChannelIds` | `string`[] | an array of sales channel ids |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`boolean`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:354](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L354)
|
||||
|
||||
___
|
||||
|
||||
@@ -419,7 +442,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L110)
|
||||
[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L110)
|
||||
|
||||
___
|
||||
|
||||
@@ -447,7 +470,7 @@ an array containing the products as
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:134](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L134)
|
||||
[packages/medusa/src/services/product.ts:134](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L134)
|
||||
|
||||
___
|
||||
|
||||
@@ -467,7 +490,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:318](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L318)
|
||||
[packages/medusa/src/services/product.ts:339](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L339)
|
||||
|
||||
___
|
||||
|
||||
@@ -481,7 +504,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:309](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L309)
|
||||
[packages/medusa/src/services/product.ts:330](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L330)
|
||||
|
||||
___
|
||||
|
||||
@@ -513,7 +536,7 @@ an object containing the query, relations and free-text
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:856](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L856)
|
||||
[packages/medusa/src/services/product.ts:900](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L900)
|
||||
|
||||
___
|
||||
|
||||
@@ -534,7 +557,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:662](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L662)
|
||||
[packages/medusa/src/services/product.ts:706](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L706)
|
||||
|
||||
___
|
||||
|
||||
@@ -560,7 +583,7 @@ the result of the find one operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:179](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L179)
|
||||
[packages/medusa/src/services/product.ts:179](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L179)
|
||||
|
||||
___
|
||||
|
||||
@@ -586,7 +609,7 @@ the result of the find one operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L209)
|
||||
[packages/medusa/src/services/product.ts:223](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L223)
|
||||
|
||||
___
|
||||
|
||||
@@ -612,7 +635,7 @@ the result of the find one operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:195](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L195)
|
||||
[packages/medusa/src/services/product.ts:202](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L202)
|
||||
|
||||
___
|
||||
|
||||
@@ -637,7 +660,7 @@ product option
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:765](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L765)
|
||||
[packages/medusa/src/services/product.ts:809](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L809)
|
||||
|
||||
___
|
||||
|
||||
@@ -662,7 +685,7 @@ an array of variants
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:260](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L260)
|
||||
[packages/medusa/src/services/product.ts:281](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L281)
|
||||
|
||||
___
|
||||
|
||||
@@ -688,7 +711,7 @@ the result of the find one operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:224](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L224)
|
||||
[packages/medusa/src/services/product.ts:245](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L245)
|
||||
|
||||
___
|
||||
|
||||
@@ -712,7 +735,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -739,7 +762,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:427](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L427)
|
||||
[packages/medusa/src/services/product.ts:471](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L471)
|
||||
|
||||
___
|
||||
|
||||
@@ -766,7 +789,7 @@ the updated product
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product.ts:708](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product.ts#L708)
|
||||
[packages/medusa/src/services/product.ts:752](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product.ts#L752)
|
||||
|
||||
___
|
||||
|
||||
@@ -790,4 +813,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-type.ts#L15)
|
||||
[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L15)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-type.ts#L10)
|
||||
[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-type.ts#L11)
|
||||
[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-type.ts#L13)
|
||||
[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L13)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -154,7 +154,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-type.ts#L55)
|
||||
[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -179,7 +179,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-type.ts#L72)
|
||||
[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -205,7 +205,7 @@ the result of the find one operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-type.ts#L30)
|
||||
[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-type.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -229,7 +229,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -253,4 +253,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L53)
|
||||
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L53)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L51)
|
||||
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L46)
|
||||
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L41)
|
||||
[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L49)
|
||||
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L48)
|
||||
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L50)
|
||||
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L45)
|
||||
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L44)
|
||||
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -146,7 +146,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L47)
|
||||
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +160,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L42)
|
||||
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -178,7 +178,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L35)
|
||||
[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L35)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -208,7 +208,7 @@ the result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L498)
|
||||
[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L498)
|
||||
|
||||
___
|
||||
|
||||
@@ -247,7 +247,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -273,7 +273,7 @@ resolves to the creation result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L147)
|
||||
[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L147)
|
||||
|
||||
___
|
||||
|
||||
@@ -298,7 +298,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L651)
|
||||
[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L651)
|
||||
|
||||
___
|
||||
|
||||
@@ -324,7 +324,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L525)
|
||||
[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L525)
|
||||
|
||||
___
|
||||
|
||||
@@ -352,7 +352,7 @@ an array containing the products as the first element and the total
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L724)
|
||||
[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L724)
|
||||
|
||||
___
|
||||
|
||||
@@ -379,7 +379,7 @@ the price specific to the region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L374)
|
||||
[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L374)
|
||||
|
||||
___
|
||||
|
||||
@@ -402,7 +402,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L593)
|
||||
[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L593)
|
||||
|
||||
___
|
||||
|
||||
@@ -425,7 +425,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L552)
|
||||
[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L552)
|
||||
|
||||
___
|
||||
|
||||
@@ -457,7 +457,7 @@ an object containing the query, relations and free-text
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L685)
|
||||
[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L685)
|
||||
|
||||
___
|
||||
|
||||
@@ -482,7 +482,7 @@ the product document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L83)
|
||||
[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
@@ -507,7 +507,7 @@ the product document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L111)
|
||||
[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -532,7 +532,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L439)
|
||||
[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L439)
|
||||
|
||||
___
|
||||
|
||||
@@ -557,7 +557,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L403)
|
||||
[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L403)
|
||||
|
||||
___
|
||||
|
||||
@@ -581,7 +581,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -608,7 +608,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L255)
|
||||
[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L255)
|
||||
|
||||
___
|
||||
|
||||
@@ -635,7 +635,7 @@ the result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L460)
|
||||
[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L460)
|
||||
|
||||
___
|
||||
|
||||
@@ -661,7 +661,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/product-variant.ts#L333)
|
||||
[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/product-variant.ts#L333)
|
||||
|
||||
___
|
||||
|
||||
@@ -685,4 +685,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L67)
|
||||
[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L59)
|
||||
[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L60)
|
||||
[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L54)
|
||||
[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L52)
|
||||
[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L64)
|
||||
[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,7 +114,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L57)
|
||||
[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L50)
|
||||
[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/region.ts#L62)
|
||||
[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -148,7 +148,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L56)
|
||||
[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -158,7 +158,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L58)
|
||||
[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -168,7 +168,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L55)
|
||||
[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -178,7 +178,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L65)
|
||||
[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -192,7 +192,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L51)
|
||||
[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -210,7 +210,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L44)
|
||||
[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L44)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -235,7 +235,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:573](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L573)
|
||||
[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L580)
|
||||
|
||||
___
|
||||
|
||||
@@ -261,7 +261,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:703](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L703)
|
||||
[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L710)
|
||||
|
||||
___
|
||||
|
||||
@@ -287,7 +287,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:652](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L652)
|
||||
[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L659)
|
||||
|
||||
___
|
||||
|
||||
@@ -326,7 +326,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -350,7 +350,7 @@ the newly created region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L117)
|
||||
[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/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:542](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L542)
|
||||
[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L549)
|
||||
|
||||
___
|
||||
|
||||
@@ -399,7 +399,7 @@ result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:522](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L522)
|
||||
[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L529)
|
||||
|
||||
___
|
||||
|
||||
@@ -424,7 +424,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:611](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L611)
|
||||
[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L618)
|
||||
|
||||
___
|
||||
|
||||
@@ -449,7 +449,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:791](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L791)
|
||||
[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L798)
|
||||
|
||||
___
|
||||
|
||||
@@ -474,7 +474,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:752](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L752)
|
||||
[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L759)
|
||||
|
||||
___
|
||||
|
||||
@@ -499,7 +499,7 @@ the region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L494)
|
||||
[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L494)
|
||||
|
||||
___
|
||||
|
||||
@@ -524,7 +524,7 @@ a Region with country code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L437)
|
||||
[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L437)
|
||||
|
||||
___
|
||||
|
||||
@@ -548,7 +548,7 @@ region with the matching name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L474)
|
||||
[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L474)
|
||||
|
||||
___
|
||||
|
||||
@@ -572,7 +572,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -597,7 +597,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L190)
|
||||
[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L190)
|
||||
|
||||
___
|
||||
|
||||
@@ -623,7 +623,7 @@ the validated Country
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L388)
|
||||
[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L388)
|
||||
|
||||
___
|
||||
|
||||
@@ -651,7 +651,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L363)
|
||||
[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L363)
|
||||
|
||||
___
|
||||
|
||||
@@ -672,7 +672,7 @@ the id can be passed to check that country updates are allowed.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `regionData` | `Omit`<`T`, ``"currency_code"`` \| ``"metadata"``\> | the region data to validate |
|
||||
| `regionData` | `Omit`<`T`, ``"metadata"`` \| ``"currency_code"``\> | the region data to validate |
|
||||
| `id?` | `T` extends `UpdateRegionInput` ? `string` : `undefined` | optional id of the region to check against |
|
||||
|
||||
#### Returns
|
||||
@@ -683,7 +683,7 @@ the validated region data
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L261)
|
||||
[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/region.ts#L261)
|
||||
|
||||
___
|
||||
|
||||
@@ -711,7 +711,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/region.ts#L347)
|
||||
[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return-reason.ts#L21)
|
||||
[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/return-reason.ts#L18)
|
||||
[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/return-reason.ts#L16)
|
||||
[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/return-reason.ts#L19)
|
||||
[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/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:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -149,7 +149,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return-reason.ts#L29)
|
||||
[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/return-reason.ts#L110)
|
||||
[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L117)
|
||||
|
||||
___
|
||||
|
||||
@@ -192,13 +192,13 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return-reason.ts#L72)
|
||||
[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`ReturnReason`\>
|
||||
▸ **retrieve**(`returnReasonId`, `config?`): `Promise`<`ReturnReason`\>
|
||||
|
||||
Gets an order by id.
|
||||
|
||||
@@ -206,7 +206,7 @@ Gets an order by id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of order to retrieve |
|
||||
| `returnReasonId` | `string` | id of order to retrieve |
|
||||
| `config` | `FindConfig`<`ReturnReason`\> | config object |
|
||||
|
||||
#### Returns
|
||||
@@ -217,7 +217,7 @@ the order document
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return-reason.ts#L91)
|
||||
[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return-reason.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
@@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -262,7 +262,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return-reason.ts#L50)
|
||||
[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L64)
|
||||
[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L63)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/return.ts#L59)
|
||||
[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L61)
|
||||
[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -82,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L56)
|
||||
[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L50)
|
||||
[packages/medusa/src/services/return.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L62)
|
||||
[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L55)
|
||||
[packages/medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L60)
|
||||
[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L54)
|
||||
[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -146,7 +146,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L58)
|
||||
[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -156,7 +156,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L57)
|
||||
[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -166,7 +166,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L53)
|
||||
[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L51)
|
||||
[packages/medusa/src/services/return.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L50)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -243,7 +243,7 @@ the updated Return
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:160](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L160)
|
||||
[packages/medusa/src/services/return.ts:159](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L159)
|
||||
|
||||
___
|
||||
|
||||
@@ -269,7 +269,7 @@ the created return
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:338](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L338)
|
||||
[packages/medusa/src/services/return.ts:344](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L344)
|
||||
|
||||
___
|
||||
|
||||
@@ -289,7 +289,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:484](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L484)
|
||||
[packages/medusa/src/services/return.ts:490](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L490)
|
||||
|
||||
___
|
||||
|
||||
@@ -315,7 +315,7 @@ the line items generated by the transformer.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:102](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L102)
|
||||
[packages/medusa/src/services/return.ts:101](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -338,7 +338,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:142](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L142)
|
||||
[packages/medusa/src/services/return.ts:141](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L141)
|
||||
|
||||
___
|
||||
|
||||
@@ -371,13 +371,13 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:555](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L555)
|
||||
[packages/medusa/src/services/return.ts:561](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L561)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`Return`\>
|
||||
▸ **retrieve**(`returnId`, `config?`): `Promise`<`Return`\>
|
||||
|
||||
Retrieves a return by its id.
|
||||
|
||||
@@ -385,7 +385,7 @@ Retrieves a return by its id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | the id of the return to retrieve |
|
||||
| `returnId` | `string` | the id of the return to retrieve |
|
||||
| `config` | `FindConfig`<`Return`\> | the config object |
|
||||
|
||||
#### Returns
|
||||
@@ -396,7 +396,7 @@ the return
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:258](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L258)
|
||||
[packages/medusa/src/services/return.ts:257](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L257)
|
||||
|
||||
___
|
||||
|
||||
@@ -417,7 +417,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:279](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L279)
|
||||
[packages/medusa/src/services/return.ts:285](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L285)
|
||||
|
||||
___
|
||||
|
||||
@@ -441,7 +441,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -462,7 +462,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:304](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L304)
|
||||
[packages/medusa/src/services/return.ts:310](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L310)
|
||||
|
||||
___
|
||||
|
||||
@@ -537,7 +537,7 @@ a line item where the quantity is set to the requested
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:216](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L216)
|
||||
[packages/medusa/src/services/return.ts:215](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L215)
|
||||
|
||||
___
|
||||
|
||||
@@ -565,7 +565,7 @@ when statuses are not sufficient for returns.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/return.ts:186](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/return.ts#L186)
|
||||
[packages/medusa/src/services/return.ts:185](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/return.ts#L185)
|
||||
|
||||
___
|
||||
|
||||
@@ -589,4 +589,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L37)
|
||||
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/sales-channel.ts#L34)
|
||||
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/sales-channel.ts#L30)
|
||||
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/sales-channel.ts#L33)
|
||||
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/sales-channel.ts#L35)
|
||||
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/sales-channel.ts#L31)
|
||||
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/sales-channel.ts#L24)
|
||||
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/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:305](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L305)
|
||||
[packages/medusa/src/services/sales-channel.ts:319](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L319)
|
||||
|
||||
___
|
||||
|
||||
@@ -192,7 +192,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -219,7 +219,7 @@ the created channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:162](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L162)
|
||||
[packages/medusa/src/services/sales-channel.ts:176](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L176)
|
||||
|
||||
___
|
||||
|
||||
@@ -237,7 +237,7 @@ the sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:252](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L252)
|
||||
[packages/medusa/src/services/sales-channel.ts:266](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L266)
|
||||
|
||||
___
|
||||
|
||||
@@ -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:213](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L213)
|
||||
[packages/medusa/src/services/sales-channel.ts:227](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L227)
|
||||
|
||||
___
|
||||
|
||||
@@ -289,7 +289,7 @@ an array containing the sales channels as
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:127](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L127)
|
||||
[packages/medusa/src/services/sales-channel.ts:141](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L141)
|
||||
|
||||
___
|
||||
|
||||
@@ -314,7 +314,7 @@ the sales channel on which the products have been removed
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:284](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L284)
|
||||
[packages/medusa/src/services/sales-channel.ts:298](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L298)
|
||||
|
||||
___
|
||||
|
||||
@@ -339,7 +339,7 @@ a sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L99)
|
||||
[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/d843bc102/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:113](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L113)
|
||||
[packages/medusa/src/services/sales-channel.ts:120](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L120)
|
||||
|
||||
___
|
||||
|
||||
@@ -389,7 +389,7 @@ a single SC matching the query or throws
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L59)
|
||||
[packages/medusa/src/services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -413,7 +413,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -434,7 +434,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:179](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/sales-channel.ts#L179)
|
||||
[packages/medusa/src/services/sales-channel.ts:193](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/sales-channel.ts#L193)
|
||||
|
||||
___
|
||||
|
||||
@@ -458,4 +458,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -25,7 +25,7 @@ AbstractSearchService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L18)
|
||||
[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/search.ts#L11)
|
||||
[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/search.ts#L15)
|
||||
[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/search.ts#L13)
|
||||
[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/search.ts#L16)
|
||||
[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/search.ts#L14)
|
||||
[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L14)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -137,7 +137,7 @@ AbstractSearchService.options
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/search-service.ts#L82)
|
||||
[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/search-service.ts#L82)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -163,7 +163,7 @@ AbstractSearchService.addDocuments
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L43)
|
||||
[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -202,7 +202,7 @@ AbstractSearchService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -227,7 +227,7 @@ AbstractSearchService.createIndex
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L31)
|
||||
[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -251,7 +251,7 @@ AbstractSearchService.deleteAllDocuments
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L72)
|
||||
[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -276,7 +276,7 @@ AbstractSearchService.deleteDocument
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L63)
|
||||
[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -300,7 +300,7 @@ AbstractSearchService.getIndex
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L37)
|
||||
[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -326,7 +326,7 @@ AbstractSearchService.replaceDocuments
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L53)
|
||||
[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -352,7 +352,7 @@ AbstractSearchService.search
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L78)
|
||||
[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
@@ -376,7 +376,7 @@ AbstractSearchService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -401,7 +401,7 @@ AbstractSearchService.updateSettings
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/search.ts#L89)
|
||||
[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/search.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
@@ -425,4 +425,4 @@ AbstractSearchService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L54)
|
||||
[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L55)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L49)
|
||||
[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L51)
|
||||
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L48)
|
||||
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L47)
|
||||
[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L43)
|
||||
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L44)
|
||||
[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L46)
|
||||
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -142,7 +142,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L52)
|
||||
[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L53)
|
||||
|
||||
## 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/105c68929/packages/medusa/src/services/shipping-option.ts#L665)
|
||||
[packages/medusa/src/services/shipping-option.ts:709](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L709)
|
||||
|
||||
___
|
||||
|
||||
@@ -207,7 +207,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -233,7 +233,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:407](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L407)
|
||||
[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L451)
|
||||
|
||||
___
|
||||
|
||||
@@ -259,7 +259,7 @@ the resulting shipping method.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:270](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L270)
|
||||
[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L278)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/shipping-option.ts#L643)
|
||||
[packages/medusa/src/services/shipping-option.ts:687](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L687)
|
||||
|
||||
___
|
||||
|
||||
@@ -307,7 +307,7 @@ removed shipping methods
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:250](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L250)
|
||||
[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L258)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/shipping-option.ts#L724)
|
||||
[packages/medusa/src/services/shipping-option.ts:768](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L768)
|
||||
|
||||
___
|
||||
|
||||
@@ -358,7 +358,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:147](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L147)
|
||||
[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L148)
|
||||
|
||||
___
|
||||
|
||||
@@ -381,7 +381,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:163](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L163)
|
||||
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
@@ -405,7 +405,7 @@ the result of update
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:694](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L694)
|
||||
[packages/medusa/src/services/shipping-option.ts:738](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L738)
|
||||
|
||||
___
|
||||
|
||||
@@ -433,7 +433,7 @@ the profile document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:181](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L181)
|
||||
[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L182)
|
||||
|
||||
___
|
||||
|
||||
@@ -457,7 +457,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/shipping-option.ts#L529)
|
||||
[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L579)
|
||||
|
||||
___
|
||||
|
||||
@@ -510,7 +510,28 @@ the resulting shipping method
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:221](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L221)
|
||||
[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L229)
|
||||
|
||||
___
|
||||
|
||||
### validateAndMutatePrice
|
||||
|
||||
▸ `Private` **validateAndMutatePrice**(`option`, `priceInput`): `Promise`<`CreateShippingOptionInput` \| `Omit`<`ShippingOption`, ``"beforeInsert"``\>\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `option` | `ShippingOption` \| `CreateShippingOptionInput` |
|
||||
| `priceInput` | `ValidatePriceTypeAndAmountInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`CreateShippingOptionInput` \| `Omit`<`ShippingOption`, ``"beforeInsert"``\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L408)
|
||||
|
||||
___
|
||||
|
||||
@@ -537,7 +558,7 @@ the validated shipping option
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:358](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L358)
|
||||
[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L366)
|
||||
|
||||
___
|
||||
|
||||
@@ -562,7 +583,7 @@ the validated price
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:493](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L493)
|
||||
[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L539)
|
||||
|
||||
___
|
||||
|
||||
@@ -587,7 +608,7 @@ a validated shipping requirement
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-option.ts:81](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-option.ts#L81)
|
||||
[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-option.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
@@ -611,4 +632,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L48)
|
||||
[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L48)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L40)
|
||||
[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L45)
|
||||
[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +90,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L43)
|
||||
[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +100,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L38)
|
||||
[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +110,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L39)
|
||||
[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +120,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L42)
|
||||
[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L46)
|
||||
[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L46)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -160,7 +160,7 @@ the result of update
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:354](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L354)
|
||||
[packages/medusa/src/services/shipping-profile.ts:361](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L361)
|
||||
|
||||
___
|
||||
|
||||
@@ -186,7 +186,7 @@ the result of the model update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:374](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L374)
|
||||
[packages/medusa/src/services/shipping-profile.ts:381](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L381)
|
||||
|
||||
___
|
||||
|
||||
@@ -225,7 +225,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -249,7 +249,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:243](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L243)
|
||||
[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L250)
|
||||
|
||||
___
|
||||
|
||||
@@ -267,7 +267,7 @@ the shipping profile
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:173](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L173)
|
||||
[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L180)
|
||||
|
||||
___
|
||||
|
||||
@@ -286,7 +286,7 @@ the shipping profile
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:217](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L217)
|
||||
[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L224)
|
||||
|
||||
___
|
||||
|
||||
@@ -310,7 +310,7 @@ the result of the delete operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:328](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L328)
|
||||
[packages/medusa/src/services/shipping-profile.ts:335](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L335)
|
||||
|
||||
___
|
||||
|
||||
@@ -335,7 +335,7 @@ a list of the available shipping options
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:394](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L394)
|
||||
[packages/medusa/src/services/shipping-profile.ts:401](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L401)
|
||||
|
||||
___
|
||||
|
||||
@@ -356,7 +356,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L83)
|
||||
[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
@@ -380,7 +380,7 @@ a list of product ids
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:460](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L460)
|
||||
[packages/medusa/src/services/shipping-profile.ts:467](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L467)
|
||||
|
||||
___
|
||||
|
||||
@@ -403,7 +403,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L71)
|
||||
[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -429,7 +429,7 @@ the profile document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L135)
|
||||
[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L135)
|
||||
|
||||
___
|
||||
|
||||
@@ -443,7 +443,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:157](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L157)
|
||||
[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
@@ -461,7 +461,7 @@ the shipping profile for gift cards
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:200](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L200)
|
||||
[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L207)
|
||||
|
||||
___
|
||||
|
||||
@@ -485,7 +485,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -512,7 +512,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/shipping-profile.ts:271](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/shipping-profile.ts#L271)
|
||||
[packages/medusa/src/services/shipping-profile.ts:278](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/shipping-profile.ts#L278)
|
||||
|
||||
___
|
||||
|
||||
@@ -536,4 +536,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L31)
|
||||
[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L28)
|
||||
[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L29)
|
||||
[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L24)
|
||||
[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L27)
|
||||
[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L25)
|
||||
[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L25)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -136,7 +136,7 @@ result after update
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L204)
|
||||
[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L204)
|
||||
|
||||
___
|
||||
|
||||
@@ -175,7 +175,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -193,7 +193,7 @@ The store.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L49)
|
||||
[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -213,7 +213,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L98)
|
||||
[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
@@ -237,7 +237,7 @@ result after update
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L248)
|
||||
[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L248)
|
||||
|
||||
___
|
||||
|
||||
@@ -261,7 +261,7 @@ the store
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L85)
|
||||
[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -285,7 +285,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -309,7 +309,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/store.ts#L114)
|
||||
[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/store.ts#L114)
|
||||
|
||||
___
|
||||
|
||||
@@ -333,4 +333,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/strategy-resolver.ts#L14)
|
||||
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/strategy-resolver.ts#L14)
|
||||
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/strategy-resolver.ts#L11)
|
||||
[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/strategy-resolver.ts#L12)
|
||||
[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/d843bc102/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:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -149,7 +149,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/strategy-resolver.ts#L19)
|
||||
[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/strategy-resolver.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
@@ -173,7 +173,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -197,4 +197,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:93](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L93)
|
||||
[packages/medusa/src/services/swap.ts:93](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L80)
|
||||
[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L91)
|
||||
[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L81)
|
||||
[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L87)
|
||||
[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +104,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L86)
|
||||
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,7 +114,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L90)
|
||||
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L85)
|
||||
[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L75)
|
||||
[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L82)
|
||||
[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L89)
|
||||
[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L83)
|
||||
[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L88)
|
||||
[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L78)
|
||||
[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L84)
|
||||
[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L76)
|
||||
[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L63)
|
||||
[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L63)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -275,7 +275,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -301,7 +301,7 @@ the canceled swap.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:845](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L845)
|
||||
[packages/medusa/src/services/swap.ts:852](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L852)
|
||||
|
||||
___
|
||||
|
||||
@@ -325,7 +325,7 @@ updated swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1046](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L1046)
|
||||
[packages/medusa/src/services/swap.ts:1053](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1053)
|
||||
|
||||
___
|
||||
|
||||
@@ -359,7 +359,7 @@ the newly created swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:307](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L307)
|
||||
[packages/medusa/src/services/swap.ts:314](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L314)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/swap.ts#L556)
|
||||
[packages/medusa/src/services/swap.ts:563](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L563)
|
||||
|
||||
___
|
||||
|
||||
@@ -413,7 +413,7 @@ the updated swap with new status and fulfillments.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:907](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L907)
|
||||
[packages/medusa/src/services/swap.ts:914](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L914)
|
||||
|
||||
___
|
||||
|
||||
@@ -440,7 +440,7 @@ the updated swap with new fulfillments and status.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1077](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L1077)
|
||||
[packages/medusa/src/services/swap.ts:1084](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1084)
|
||||
|
||||
___
|
||||
|
||||
@@ -465,7 +465,7 @@ resolves to the updated result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1155](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L1155)
|
||||
[packages/medusa/src/services/swap.ts:1162](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1162)
|
||||
|
||||
___
|
||||
|
||||
@@ -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/105c68929/packages/medusa/src/services/swap.ts#L277)
|
||||
[packages/medusa/src/services/swap.ts:284](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L284)
|
||||
|
||||
___
|
||||
|
||||
@@ -514,7 +514,7 @@ processed swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:400](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L400)
|
||||
[packages/medusa/src/services/swap.ts:407](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L407)
|
||||
|
||||
___
|
||||
|
||||
@@ -538,7 +538,7 @@ swap related to the cart
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:694](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L694)
|
||||
[packages/medusa/src/services/swap.ts:701](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L701)
|
||||
|
||||
___
|
||||
|
||||
@@ -563,13 +563,13 @@ the resulting order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:1195](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L1195)
|
||||
[packages/medusa/src/services/swap.ts:1202](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L1202)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`Swap`\>
|
||||
▸ **retrieve**(`swapId`, `config?`): `Promise`<`Swap`\>
|
||||
|
||||
Retrieves a swap with the given id.
|
||||
|
||||
@@ -577,7 +577,7 @@ Retrieves a swap with the given id.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | the id of the swap to retrieve |
|
||||
| `swapId` | `string` | the id of the swap to retrieve |
|
||||
| `config` | `Omit`<`FindConfig`<`Swap`\>, ``"select"``\> & { `select?`: `string`[] } | the configuration to retrieve the swap |
|
||||
|
||||
#### Returns
|
||||
@@ -588,7 +588,7 @@ the swap
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:208](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L208)
|
||||
[packages/medusa/src/services/swap.ts:208](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L250)
|
||||
[packages/medusa/src/services/swap.ts:257](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L257)
|
||||
|
||||
___
|
||||
|
||||
@@ -637,7 +637,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -661,7 +661,7 @@ transformed find swap config
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/swap.ts:135](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/swap.ts#L135)
|
||||
[packages/medusa/src/services/swap.ts:135](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/swap.ts#L523)
|
||||
[packages/medusa/src/services/swap.ts:530](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/swap.ts#L530)
|
||||
|
||||
___
|
||||
|
||||
@@ -710,4 +710,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/system-payment-provider.ts#L10)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L5)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L6)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L8)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/d843bc102/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:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -149,7 +149,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/system-payment-provider.ts#L26)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L50)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L42)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L14)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L38)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L22)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L18)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L46)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/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:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -333,7 +333,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/system-payment-provider.ts#L34)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/system-payment-provider.ts#L30)
|
||||
[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L53)
|
||||
[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L51)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,17 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
### cacheService\_
|
||||
|
||||
• `Protected` `Readonly` **cacheService\_**: `ICacheService`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L45)
|
||||
[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L51)
|
||||
[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,17 +98,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
### redis\_
|
||||
|
||||
• `Protected` `Readonly` **redis\_**: `Redis`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L50)
|
||||
[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L48)
|
||||
[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L47)
|
||||
[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L49)
|
||||
[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -138,7 +138,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L46)
|
||||
[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L43)
|
||||
[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L41)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -191,7 +191,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -211,7 +211,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L94)
|
||||
[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -231,7 +231,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L104)
|
||||
[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -257,7 +257,7 @@ the newly created tax lines
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:180](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L180)
|
||||
[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L183)
|
||||
|
||||
___
|
||||
|
||||
@@ -282,38 +282,13 @@ the newly created tax lines
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:126](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L126)
|
||||
|
||||
___
|
||||
|
||||
### getCacheEntry
|
||||
|
||||
▸ `Private` **getCacheEntry**(`productId`, `regionId`): `Promise`<``null`` \| `TaxServiceRate`[]\>
|
||||
|
||||
Gets the cache results for a set of ids
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `productId` | `string` | the product id to cache |
|
||||
| `regionId` | `string` | the region id to cache |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<``null`` \| `TaxServiceRate`[]\>
|
||||
|
||||
the cached result or null
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:503](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L503)
|
||||
[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L129)
|
||||
|
||||
___
|
||||
|
||||
### getCacheKey
|
||||
|
||||
▸ `Private` **getCacheKey**(`productId`, `regionId`): `string`
|
||||
▸ `Private` **getCacheKey**(`id`, `regionId`): `string`
|
||||
|
||||
The cache key to get cache hits by.
|
||||
|
||||
@@ -321,7 +296,7 @@ The cache key to get cache hits by.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `productId` | `string` | the product id to cache |
|
||||
| `id` | `string` | the entity id to cache |
|
||||
| `regionId` | `string` | the region id to cache |
|
||||
|
||||
#### Returns
|
||||
@@ -332,7 +307,7 @@ the cache key to use for the id set
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:472](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L472)
|
||||
[packages/medusa/src/services/tax-provider.ts:477](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L477)
|
||||
|
||||
___
|
||||
|
||||
@@ -358,7 +333,7 @@ the tax rates configured for the shipping option.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:425](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L425)
|
||||
[packages/medusa/src/services/tax-provider.ts:429](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L429)
|
||||
|
||||
___
|
||||
|
||||
@@ -384,7 +359,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/105c68929/packages/medusa/src/services/tax-provider.ts#L379)
|
||||
[packages/medusa/src/services/tax-provider.ts:382](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L382)
|
||||
|
||||
___
|
||||
|
||||
@@ -411,7 +386,7 @@ the computed tax lines
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:201](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L201)
|
||||
[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L204)
|
||||
|
||||
___
|
||||
|
||||
@@ -440,7 +415,7 @@ the computed tax lines
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:253](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L253)
|
||||
[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L256)
|
||||
|
||||
___
|
||||
|
||||
@@ -463,7 +438,7 @@ Return a map of tax lines for line items and shipping methods
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:342](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L342)
|
||||
[packages/medusa/src/services/tax-provider.ts:345](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L345)
|
||||
|
||||
___
|
||||
|
||||
@@ -477,7 +452,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L66)
|
||||
[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -497,7 +472,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:524](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L524)
|
||||
[packages/medusa/src/services/tax-provider.ts:481](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L481)
|
||||
|
||||
___
|
||||
|
||||
@@ -521,33 +496,7 @@ the region specific tax provider
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
### setCache
|
||||
|
||||
▸ `Private` **setCache**(`productId`, `regionId`, `value`): `Promise`<``null`` \| `string`\>
|
||||
|
||||
Sets the cache results for a set of ids
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `productId` | `string` | the product id to cache |
|
||||
| `regionId` | `string` | the region id to cache |
|
||||
| `value` | `TaxServiceRate`[] | tax rates to cache |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<``null`` \| `string`\>
|
||||
|
||||
promise that resolves after the cache has been set
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-provider.ts:483](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-provider.ts#L483)
|
||||
[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-provider.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
@@ -571,7 +520,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -595,4 +544,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L31)
|
||||
[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L33)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L23)
|
||||
[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L26)
|
||||
[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L27)
|
||||
[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L28)
|
||||
[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L29)
|
||||
[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L24)
|
||||
[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L26)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -142,7 +142,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:181](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L181)
|
||||
[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L190)
|
||||
|
||||
___
|
||||
|
||||
@@ -164,7 +164,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:217](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L217)
|
||||
[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L226)
|
||||
|
||||
___
|
||||
|
||||
@@ -186,7 +186,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:257](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L257)
|
||||
[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L266)
|
||||
|
||||
___
|
||||
|
||||
@@ -225,7 +225,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -245,7 +245,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:88](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L88)
|
||||
[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
@@ -265,7 +265,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:119](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L119)
|
||||
[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L128)
|
||||
|
||||
___
|
||||
|
||||
@@ -286,7 +286,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L47)
|
||||
[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -307,7 +307,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L58)
|
||||
[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -328,7 +328,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:305](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L305)
|
||||
[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L314)
|
||||
|
||||
___
|
||||
|
||||
@@ -348,7 +348,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:315](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L315)
|
||||
[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L324)
|
||||
|
||||
___
|
||||
|
||||
@@ -369,7 +369,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:127](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L127)
|
||||
[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L136)
|
||||
|
||||
___
|
||||
|
||||
@@ -390,7 +390,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:145](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L145)
|
||||
[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L154)
|
||||
|
||||
___
|
||||
|
||||
@@ -411,19 +411,19 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:163](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L163)
|
||||
[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L172)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `config?`): `Promise`<`TaxRate`\>
|
||||
▸ **retrieve**(`taxRateId`, `config?`): `Promise`<`TaxRate`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `taxRateId` | `string` |
|
||||
| `config` | `FindConfig`<`TaxRate`\> |
|
||||
|
||||
#### Returns
|
||||
@@ -432,7 +432,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L69)
|
||||
[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -456,7 +456,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -477,7 +477,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/tax-rate.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/tax-rate.ts#L104)
|
||||
[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/tax-rate.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -501,4 +501,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -0,0 +1,79 @@
|
||||
# Class: TokenService
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new TokenService**(`__namedParameters`)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `__namedParameters` | `InjectedDependencies` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L16)
|
||||
|
||||
## Properties
|
||||
|
||||
### configModule\_
|
||||
|
||||
• `Protected` `Readonly` **configModule\_**: `ConfigModule`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### RESOLUTION\_KEY
|
||||
|
||||
▪ `Static` **RESOLUTION\_KEY**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L12)
|
||||
|
||||
## Methods
|
||||
|
||||
### signToken
|
||||
|
||||
▸ **signToken**(`data`, `options?`): `string`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `data` | `string` \| `object` \| `Buffer` |
|
||||
| `options?` | `SignOptions` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
### verifyToken
|
||||
|
||||
▸ **verifyToken**(`token`, `options?`): `string` \| `Jwt` \| `JwtPayload`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `token` | `string` |
|
||||
| `options?` | `VerifyOptions` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`string` \| `Jwt` \| `JwtPayload`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/token.ts#L20)
|
||||
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L108)
|
||||
[packages/medusa/src/services/totals.ts:116](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L116)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/services/totals.ts#L106)
|
||||
[packages/medusa/src/services/totals.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L114)
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +80,17 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L101)
|
||||
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L108)
|
||||
|
||||
___
|
||||
|
||||
### newTotalsService\_
|
||||
|
||||
• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](NewTotalsService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +100,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L105)
|
||||
[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +110,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L104)
|
||||
[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,7 +124,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L102)
|
||||
[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L109)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -153,7 +163,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -181,7 +191,7 @@ triples of lineitem, variant and applied discount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:609](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L609)
|
||||
[packages/medusa/src/services/totals.ts:624](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L624)
|
||||
|
||||
___
|
||||
|
||||
@@ -210,7 +220,7 @@ array of triples of lineitem, variant and applied discount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:651](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L651)
|
||||
[packages/medusa/src/services/totals.ts:666](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L666)
|
||||
|
||||
___
|
||||
|
||||
@@ -226,7 +236,11 @@ applies to a specific line item.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `orderOrCart` | `Cart` \| `Order` | the order or cart to get an allocation map for |
|
||||
| `orderOrCart` | `Object` | the order or cart to get an allocation map for |
|
||||
| `orderOrCart.claims?` | `ClaimOrder`[] | - |
|
||||
| `orderOrCart.discounts?` | `Discount`[] | - |
|
||||
| `orderOrCart.items` | `LineItem`[] | - |
|
||||
| `orderOrCart.swaps?` | `Swap`[] | - |
|
||||
| `options` | `AllocationMapOptions` | controls what should be included in allocation map |
|
||||
|
||||
#### Returns
|
||||
@@ -237,13 +251,13 @@ the allocation map for the line items in the cart or order.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:431](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L431)
|
||||
[packages/medusa/src/services/totals.ts:441](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L441)
|
||||
|
||||
___
|
||||
|
||||
### getCalculationContext
|
||||
|
||||
▸ **getCalculationContext**(`cartOrOrder`, `options?`): `Promise`<`TaxCalculationContext`\>
|
||||
▸ **getCalculationContext**(`calculationContextData`, `options?`): `Promise`<`TaxCalculationContext`\>
|
||||
|
||||
Prepares the calculation context for a tax total calculation.
|
||||
|
||||
@@ -251,7 +265,7 @@ Prepares the calculation context for a tax total calculation.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to get the calculation context for |
|
||||
| `calculationContextData` | `CalculationContextData` | the calculationContextData to get the calculation context for |
|
||||
| `options` | `CalculationContextOptions` | options to gather context by |
|
||||
|
||||
#### Returns
|
||||
@@ -262,7 +276,7 @@ the tax calculation context
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:1058](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L1058)
|
||||
[packages/medusa/src/services/totals.ts:1028](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L1028)
|
||||
|
||||
___
|
||||
|
||||
@@ -287,7 +301,7 @@ the total discounts amount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:1028](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L1028)
|
||||
[packages/medusa/src/services/totals.ts:998](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L998)
|
||||
|
||||
___
|
||||
|
||||
@@ -313,7 +327,7 @@ the gift card amount applied to the cart or order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:945](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L945)
|
||||
[packages/medusa/src/services/totals.ts:964](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L964)
|
||||
|
||||
___
|
||||
|
||||
@@ -338,7 +352,7 @@ the gift card amount applied to the cart or order
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:928](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L928)
|
||||
[packages/medusa/src/services/totals.ts:947](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L947)
|
||||
|
||||
___
|
||||
|
||||
@@ -352,7 +366,10 @@ Returns the discount amount allocated to the line items of an order.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to get line discount allocations for |
|
||||
| `cartOrOrder` | `Object` | the cart or order to get line discount allocations for |
|
||||
| `cartOrOrder.claims?` | `ClaimOrder`[] | - |
|
||||
| `cartOrOrder.items` | `LineItem`[] | - |
|
||||
| `cartOrOrder.swaps?` | `Swap`[] | - |
|
||||
| `discount` | `Discount` | the discount to use as context for the calculation |
|
||||
|
||||
#### Returns
|
||||
@@ -364,7 +381,7 @@ the allocations that the discount has on the items in the cart or
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L702)
|
||||
[packages/medusa/src/services/totals.ts:717](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L717)
|
||||
|
||||
___
|
||||
|
||||
@@ -384,7 +401,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:679](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L679)
|
||||
[packages/medusa/src/services/totals.ts:694](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L694)
|
||||
|
||||
___
|
||||
|
||||
@@ -405,7 +422,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:664](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L664)
|
||||
[packages/medusa/src/services/totals.ts:679](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L679)
|
||||
|
||||
___
|
||||
|
||||
@@ -430,7 +447,7 @@ the line item refund amount.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:487](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L487)
|
||||
[packages/medusa/src/services/totals.ts:502](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L502)
|
||||
|
||||
___
|
||||
|
||||
@@ -457,7 +474,7 @@ the line item total
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:901](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L901)
|
||||
[packages/medusa/src/services/totals.ts:920](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L920)
|
||||
|
||||
___
|
||||
|
||||
@@ -485,7 +502,7 @@ the breakdown of the line item totals
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:748](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L748)
|
||||
[packages/medusa/src/services/totals.ts:767](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L767)
|
||||
|
||||
___
|
||||
|
||||
@@ -509,7 +526,7 @@ the total paid amount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:153](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L153)
|
||||
[packages/medusa/src/services/totals.ts:163](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L163)
|
||||
|
||||
___
|
||||
|
||||
@@ -536,7 +553,7 @@ the calculated subtotal
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:566](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L566)
|
||||
[packages/medusa/src/services/totals.ts:581](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L581)
|
||||
|
||||
___
|
||||
|
||||
@@ -560,7 +577,7 @@ the total refunded amount for an order.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:472](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L472)
|
||||
[packages/medusa/src/services/totals.ts:487](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L487)
|
||||
|
||||
___
|
||||
|
||||
@@ -587,7 +604,7 @@ An object that breaks down the totals for the shipping method
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:187](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L187)
|
||||
[packages/medusa/src/services/totals.ts:197](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L197)
|
||||
|
||||
___
|
||||
|
||||
@@ -611,7 +628,7 @@ shipping total
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:315](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L315)
|
||||
[packages/medusa/src/services/totals.ts:325](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L325)
|
||||
|
||||
___
|
||||
|
||||
@@ -636,7 +653,7 @@ the calculated subtotal
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:279](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L279)
|
||||
[packages/medusa/src/services/totals.ts:289](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L289)
|
||||
|
||||
___
|
||||
|
||||
@@ -661,7 +678,7 @@ the swap total
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:168](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L168)
|
||||
[packages/medusa/src/services/totals.ts:178](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L178)
|
||||
|
||||
___
|
||||
|
||||
@@ -687,7 +704,7 @@ tax total
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:342](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L342)
|
||||
[packages/medusa/src/services/totals.ts:352](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L352)
|
||||
|
||||
___
|
||||
|
||||
@@ -712,7 +729,7 @@ the calculated subtotal
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:130](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L130)
|
||||
[packages/medusa/src/services/totals.ts:140](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L140)
|
||||
|
||||
___
|
||||
|
||||
@@ -736,7 +753,7 @@ the rounded value
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/totals.ts:1088](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/totals.ts#L1088)
|
||||
[packages/medusa/src/services/totals.ts:1058](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/totals.ts#L1058)
|
||||
|
||||
___
|
||||
|
||||
@@ -760,7 +777,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -784,4 +801,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L47)
|
||||
[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/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/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L42)
|
||||
[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L44)
|
||||
[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L45)
|
||||
[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L40)
|
||||
[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L41)
|
||||
[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L43)
|
||||
[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -141,7 +141,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L33)
|
||||
[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L33)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -180,7 +180,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -206,7 +206,7 @@ the result of create
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:172](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L172)
|
||||
[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L179)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,7 +230,7 @@ the result of the delete operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:252](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L252)
|
||||
[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L259)
|
||||
|
||||
___
|
||||
|
||||
@@ -258,7 +258,7 @@ the generated JSON web token
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:314](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L314)
|
||||
[packages/medusa/src/services/user.ts:321](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L321)
|
||||
|
||||
___
|
||||
|
||||
@@ -282,7 +282,7 @@ hashed password
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:160](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L160)
|
||||
[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
@@ -305,7 +305,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L69)
|
||||
[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -331,7 +331,7 @@ the user document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L82)
|
||||
[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
@@ -347,7 +347,7 @@ Throws in case of DB Error and if user was not found.
|
||||
| Name | Type | Default value | Description |
|
||||
| :------ | :------ | :------ | :------ |
|
||||
| `apiToken` | `string` | `undefined` | the token of the user to get. |
|
||||
| `relations` | `string`[] | `[]` | relations to include with the user |
|
||||
| `relations` | `string`[] | `[]` | relations to include with the user. |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -357,7 +357,7 @@ the user document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L106)
|
||||
[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -383,7 +383,7 @@ the user document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:135](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L135)
|
||||
[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L142)
|
||||
|
||||
___
|
||||
|
||||
@@ -410,7 +410,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:285](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L285)
|
||||
[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L292)
|
||||
|
||||
___
|
||||
|
||||
@@ -434,7 +434,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
@@ -459,7 +459,7 @@ the result of create
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/user.ts:206](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/user.ts#L206)
|
||||
[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/user.ts#L213)
|
||||
|
||||
___
|
||||
|
||||
@@ -483,4 +483,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
@@ -5,6 +5,7 @@
|
||||
- [AnalyticsConfigService](classes/AnalyticsConfigService.md)
|
||||
- [AuthService](classes/AuthService.md)
|
||||
- [BatchJobService](classes/BatchJobService.md)
|
||||
- [CacheService](classes/CacheService.md)
|
||||
- [CartService](classes/CartService.md)
|
||||
- [ClaimItemService](classes/ClaimItemService.md)
|
||||
- [ClaimService](classes/ClaimService.md)
|
||||
@@ -53,5 +54,6 @@
|
||||
- [SystemPaymentProviderService](classes/SystemPaymentProviderService.md)
|
||||
- [TaxProviderService](classes/TaxProviderService.md)
|
||||
- [TaxRateService](classes/TaxRateService.md)
|
||||
- [TokenService](classes/TokenService.md)
|
||||
- [TotalsService](classes/TotalsService.md)
|
||||
- [UserService](classes/UserService.md)
|
||||
Reference in new issue
Block a user