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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2023-04-04 21:01:53 +03:00
1 parent 3838067a54
commit 198f39f8d4
60 files changed
+3569 -2425
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/content/references/services/classes/AnalyticsConfigService.md
+36 -18
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L24) [medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/analytics-config.ts#L21)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### analyticsConfigRepository\_ ### analyticsConfigRepository\_
• `Protected` `Readonly` **analyticsConfigRepository\_**: typeof `AnalyticsConfigRepository` • `Protected` `Readonly` **analyticsConfigRepository\_**: `Repository`<`AnalyticsConfig`\>
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L21) [medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/analytics-config.ts#L18)
___ ___
@@ -84,13 +84,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L18) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -98,13 +98,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L19) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -114,7 +114,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:22](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L22) [medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/analytics-config.ts#L19)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -153,7 +171,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -176,7 +194,7 @@ Creates an analytics config.
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L56) [medusa/src/services/analytics-config.ts:50](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/analytics-config.ts#L50)
___ ___
@@ -198,7 +216,7 @@ Deletes an analytics config.
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:103](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L103) [medusa/src/services/analytics-config.ts:94](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/analytics-config.ts#L94)
___ ___
@@ -218,7 +236,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:32](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L32) [medusa/src/services/analytics-config.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/analytics-config.ts#L28)
___ ___
@@ -242,7 +260,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -265,7 +283,7 @@ Updates an analytics config. If the config does not exist, it will be created in
#### Defined in #### Defined in
[packages/medusa/src/services/analytics-config.ts:72](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/analytics-config.ts#L72) [medusa/src/services/analytics-config.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/analytics-config.ts#L65)
___ ___
@@ -289,4 +307,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/AuthService.md
+35 -17
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L24) [medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/auth.ts#L22)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L22) [medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/auth.ts#L20)
___ ___
@@ -86,13 +86,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L19) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -100,13 +100,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -116,7 +116,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L21) [medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/auth.ts#L19)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -155,7 +173,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -183,7 +201,7 @@ success: whether authentication succeeded
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L97) [medusa/src/services/auth.ts:95](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/auth.ts#L95)
___ ___
@@ -209,7 +227,7 @@ success: whether authentication succeeded
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L54) [medusa/src/services/auth.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/auth.ts#L52)
___ ___
@@ -237,7 +255,7 @@ success: whether authentication succeeded
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L146) [medusa/src/services/auth.ts:144](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/auth.ts#L144)
___ ___
@@ -262,7 +280,7 @@ the result of the comparison
#### Defined in #### Defined in
[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/auth.ts#L38) [medusa/src/services/auth.ts:36](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/auth.ts#L36)
___ ___
@@ -286,7 +304,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -310,4 +328,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/BatchJobService.md
+47 -29
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L93) [medusa/src/services/batch-job.ts:91](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L91)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### batchJobRepository\_ ### batchJobRepository\_
• `Protected` `Readonly` **batchJobRepository\_**: typeof `BatchJobRepository` • `Protected` `Readonly` **batchJobRepository\_**: `Repository`<`BatchJob`\>
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L41) [medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L39)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L45) [medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L43)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L42) [medusa/src/services/batch-job.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L40)
___ ___
@@ -104,13 +104,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L38) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L43) [medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L41)
___ ___
@@ -128,13 +128,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L39) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -157,7 +157,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L27) [medusa/src/services/batch-job.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L28)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -196,7 +214,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -216,7 +234,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:277](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L277) [medusa/src/services/batch-job.ts:270](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L270)
___ ___
@@ -236,7 +254,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:259](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L259) [medusa/src/services/batch-job.ts:252](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L252)
___ ___
@@ -256,7 +274,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:241](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L241) [medusa/src/services/batch-job.ts:234](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L234)
___ ___
@@ -276,7 +294,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:146](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L146) [medusa/src/services/batch-job.ts:144](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L144)
___ ___
@@ -297,7 +315,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:135](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L135) [medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L132)
___ ___
@@ -318,7 +336,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:374](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L374) [medusa/src/services/batch-job.ts:367](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L367)
___ ___
@@ -339,7 +357,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:108](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L108) [medusa/src/services/batch-job.ts:104](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L104)
___ ___
@@ -360,7 +378,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:348](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L348) [medusa/src/services/batch-job.ts:341](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L341)
___ ___
@@ -380,7 +398,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:295](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L295) [medusa/src/services/batch-job.ts:288](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L288)
___ ___
@@ -400,7 +418,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:328](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L328) [medusa/src/services/batch-job.ts:321](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L321)
___ ___
@@ -424,7 +442,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -445,7 +463,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:165](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L165) [medusa/src/services/batch-job.ts:161](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L161)
___ ___
@@ -466,7 +484,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/batch-job.ts:206](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/batch-job.ts#L206) [medusa/src/services/batch-job.ts:200](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/batch-job.ts#L200)
___ ___
@@ -490,4 +508,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/CacheService.md
-119
View File
@@ -1,119 +0,0 @@
# 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/a4575c391/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/a4575c391/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/a4575c391/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/a4575c391/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/a4575c391/packages/medusa/src/services/cache.ts#L22)
docs/content/references/services/classes/CartService.md
+105 -87
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:137](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L137) [medusa/src/services/cart.ts:134](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L134)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,27 +66,27 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### addressRepository\_ ### addressRepository\_
• `Protected` `Readonly` **addressRepository\_**: typeof `AddressRepository` • `Protected` `Readonly` **addressRepository\_**: `Repository`<`Address`\>
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L112) [medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L109)
___ ___
### cartRepository\_ ### cartRepository\_
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository` • `Protected` `Readonly` **cartRepository\_**: `Repository`<`Cart`\>
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L111) [medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L108)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L130) [medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L127)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L123) [medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L120)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L125) [medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L122)
___ ___
@@ -126,7 +126,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L115) [medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L112)
___ ___
@@ -136,7 +136,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:133](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L133) [medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L130)
___ ___
@@ -146,7 +146,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L126) [medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L123)
___ ___
@@ -156,17 +156,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L132) [medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L129)
___ ___
### lineItemRepository\_ ### lineItemRepository\_
• `Protected` `Readonly` **lineItemRepository\_**: typeof `LineItemRepository` • `Protected` `Readonly` **lineItemRepository\_**: `Repository`<`LineItem`\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<`LineItem` & { `return_item`: `ReturnItem` }[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L114) [medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L111)
___ ___
@@ -176,7 +176,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L121) [medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L118)
___ ___
@@ -184,13 +184,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L107) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -200,7 +200,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L129) [medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L126)
___ ___
@@ -210,17 +210,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L122) [medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L119)
___ ___
### paymentSessionRepository\_ ### paymentSessionRepository\_
• `Protected` `Readonly` **paymentSessionRepository\_**: typeof `PaymentSessionRepository` • `Protected` `Readonly` **paymentSessionRepository\_**: `Repository`<`PaymentSession`\>
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L113) [medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L110)
___ ___
@@ -230,7 +230,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L131) [medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L128)
___ ___
@@ -240,7 +240,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L117) [medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L114)
___ ___
@@ -250,7 +250,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:135](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L135) [medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L132)
___ ___
@@ -260,7 +260,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L116) [medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L113)
___ ___
@@ -270,7 +270,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L120) [medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L117)
___ ___
@@ -280,17 +280,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L119) [medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L116)
___ ___
### shippingMethodRepository\_ ### shippingMethodRepository\_
• `Protected` `Readonly` **shippingMethodRepository\_**: typeof `ShippingMethodRepository` • `Protected` `Readonly` **shippingMethodRepository\_**: `Repository`<`ShippingMethod`\>
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L110) [medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L107)
___ ___
@@ -300,7 +300,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L124) [medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L121)
___ ___
@@ -310,7 +310,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L118) [medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L115)
___ ___
@@ -320,7 +320,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L127) [medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L124)
___ ___
@@ -330,7 +330,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L128) [medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L125)
___ ___
@@ -338,13 +338,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L108) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -362,7 +362,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L101) [medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L101)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -393,7 +411,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:619](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L619) [medusa/src/services/cart.ts:614](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L614)
___ ___
@@ -421,7 +439,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:745](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L745) [medusa/src/services/cart.ts:747](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L747)
___ ___
@@ -439,7 +457,7 @@ shop.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrId` | `string` \| `Cart` | the id or the cart to add shipping method to | | `cartOrId` | `string` \| `Cart` | the id of the cart to add shipping method to |
| `optionId` | `string` | id of shipping option to add as valid method | | `optionId` | `string` | id of shipping option to add as valid method |
| `data` | `Record`<`string`, `unknown`\> | the fulmillment data for the method | | `data` | `Record`<`string`, `unknown`\> | the fulmillment data for the method |
@@ -451,7 +469,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2068](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2068) [medusa/src/services/cart.ts:2091](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2091)
___ ___
@@ -479,7 +497,7 @@ void
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:992](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L992) [medusa/src/services/cart.ts:1008](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1008)
___ ___
@@ -505,7 +523,7 @@ Throws if discount regions does not include the cart region
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1414](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1414) [medusa/src/services/cart.ts:1429](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1429)
___ ___
@@ -531,7 +549,7 @@ Throws if discount regions does not include the cart region
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1426](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1426) [medusa/src/services/cart.ts:1441](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1441)
___ ___
@@ -552,7 +570,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1379](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1379) [medusa/src/services/cart.ts:1394](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1394)
___ ___
@@ -591,7 +609,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -620,7 +638,7 @@ the resulting cart
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1592](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1592) [medusa/src/services/cart.ts:1607](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1607)
___ ___
@@ -644,7 +662,7 @@ the result of the create operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L320) [medusa/src/services/cart.ts:306](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L306)
___ ___
@@ -668,7 +686,7 @@ the resultign customer object
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1266](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1266) [medusa/src/services/cart.ts:1280](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1280)
___ ___
@@ -688,7 +706,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2477](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2477) [medusa/src/services/cart.ts:2497](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2497)
___ ___
@@ -709,7 +727,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2527](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2527) [medusa/src/services/cart.ts:2549](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2549)
___ ___
@@ -735,7 +753,7 @@ Use decorateTotals instead
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2700](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2700) [medusa/src/services/cart.ts:2724](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2724)
___ ___
@@ -759,7 +777,7 @@ the deleted cart or undefined if the cart was not found.
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2392](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2392) [medusa/src/services/cart.ts:2414](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2414)
___ ___
@@ -784,7 +802,7 @@ the resulting cart.
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1959](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1959) [medusa/src/services/cart.ts:1984](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1984)
___ ___
@@ -804,7 +822,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2508](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2508) [medusa/src/services/cart.ts:2530](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2530)
___ ___
@@ -830,7 +848,7 @@ custom shipping option
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2175](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2175) [medusa/src/services/cart.ts:2198](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2198)
___ ___
@@ -850,7 +868,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2751](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2751) [medusa/src/services/cart.ts:2775](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2775)
___ ___
@@ -870,7 +888,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:456](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L456) [medusa/src/services/cart.ts:444](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L444)
___ ___
@@ -893,7 +911,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:201](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L201) [medusa/src/services/cart.ts:196](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L196)
___ ___
@@ -918,7 +936,7 @@ void
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1212](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1212) [medusa/src/services/cart.ts:1226](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1226)
___ ___
@@ -938,7 +956,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2621](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2621) [medusa/src/services/cart.ts:2648](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2648)
___ ___
@@ -963,7 +981,7 @@ the resulting cart.
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2013](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2013) [medusa/src/services/cart.ts:2036](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2036)
___ ___
@@ -988,7 +1006,7 @@ the resulting cart
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1502](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1502) [medusa/src/services/cart.ts:1517](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1517)
___ ___
@@ -1013,7 +1031,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:488](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L488) [medusa/src/services/cart.ts:476](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L476)
___ ___
@@ -1039,7 +1057,7 @@ the cart document.
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:219](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L219) [medusa/src/services/cart.ts:213](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L213)
___ ___
@@ -1063,7 +1081,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:268](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L268) [medusa/src/services/cart.ts:258](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L258)
___ ___
@@ -1085,7 +1103,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:300](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L300) [medusa/src/services/cart.ts:286](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L286)
___ ___
@@ -1113,7 +1131,7 @@ resolves to the updated result.
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2435](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2435) [medusa/src/services/cart.ts:2457](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2457)
___ ___
@@ -1136,7 +1154,7 @@ Selects a payment session for a cart and creates a payment object in the externa
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1666](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1666) [medusa/src/services/cart.ts:1686](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1686)
___ ___
@@ -1164,7 +1182,7 @@ the result of the update operation.
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1781](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1781) [medusa/src/services/cart.ts:1804](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1804)
___ ___
@@ -1190,7 +1208,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2258](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2258) [medusa/src/services/cart.ts:2284](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2284)
___ ___
@@ -1214,7 +1232,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -1234,7 +1252,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2642](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2642) [medusa/src/services/cart.ts:2666](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2666)
___ ___
@@ -1255,7 +1273,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1035](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1035) [medusa/src/services/cart.ts:1049](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1049)
___ ___
@@ -1271,7 +1289,7 @@ Updates the cart's billing address.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart` | `Cart` | the cart to update | | `cart` | `Cart` | the cart to update |
| `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | the value to set the billing address to | | `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | the value to set the billing address to |
| `addrRepo` | `AddressRepository` | the repository to use for address updates | | `addrRepo` | `Repository`<`Address`\> | the repository to use for address updates |
#### Returns #### Returns
@@ -1281,7 +1299,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1292](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1292) [medusa/src/services/cart.ts:1307](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1307)
___ ___
@@ -1306,7 +1324,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1248](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1248) [medusa/src/services/cart.ts:1262](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1262)
___ ___
@@ -1332,7 +1350,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:915](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L915) [medusa/src/services/cart.ts:924](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L924)
___ ___
@@ -1357,7 +1375,7 @@ the resulting cart
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1554](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1554) [medusa/src/services/cart.ts:1569](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1569)
___ ___
@@ -1373,7 +1391,7 @@ Updates the cart's shipping address.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart` | `Cart` | the cart to update | | `cart` | `Cart` | the cart to update |
| `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | the value to set the shipping address to | | `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | the value to set the shipping address to |
| `addrRepo` | `AddressRepository` | the repository to use for address updates | | `addrRepo` | `Repository`<`Address`\> | the repository to use for address updates |
#### Returns #### Returns
@@ -1383,7 +1401,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:1330](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L1330) [medusa/src/services/cart.ts:1345](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L1345)
___ ___
@@ -1405,7 +1423,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:2194](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L2194) [medusa/src/services/cart.ts:2217](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L2217)
___ ___
@@ -1431,7 +1449,7 @@ a boolean indicating validation result
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:585](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L585) [medusa/src/services/cart.ts:580](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L580)
___ ___
@@ -1458,7 +1476,7 @@ boolean representing whether shipping method is validated
#### Defined in #### Defined in
[packages/medusa/src/services/cart.ts:554](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/cart.ts#L554) [medusa/src/services/cart.ts:549](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/cart.ts#L549)
___ ___
@@ -1482,4 +1500,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ClaimItemService.md
+42 -24
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L30) [medusa/src/services/claim-item.ts:26](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L26)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,37 +66,37 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### claimImageRepository\_ ### claimImageRepository\_
• `Protected` `Readonly` **claimImageRepository\_**: typeof `ClaimImageRepository` • `Protected` `Readonly` **claimImageRepository\_**: `Repository`<`ClaimImage`\>
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L25) [medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L24)
___ ___
### claimItemRepository\_ ### claimItemRepository\_
• `Protected` `Readonly` **claimItemRepository\_**: typeof `ClaimItemRepository` • `Protected` `Readonly` **claimItemRepository\_**: `Repository`<`ClaimItem`\>
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L23) [medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L22)
___ ___
### claimTagRepository\_ ### claimTagRepository\_
• `Protected` `Readonly` **claimTagRepository\_**: typeof `ClaimTagRepository` • `Protected` `Readonly` **claimTagRepository\_**: `Repository`<`ClaimTag`\>
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L24) [medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L23)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L22) [medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L21)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L21) [medusa/src/services/claim-item.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L20)
___ ___
@@ -124,13 +124,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L27) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -138,13 +138,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L28) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -162,7 +162,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L15) [medusa/src/services/claim-item.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L14)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -201,7 +219,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -221,7 +239,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L49) [medusa/src/services/claim-item.ts:43](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L43)
___ ___
@@ -244,7 +262,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:221](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L221) [medusa/src/services/claim-item.ts:205](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L205)
___ ___
@@ -269,7 +287,7 @@ the ClaimItem
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:240](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L240) [medusa/src/services/claim-item.ts:224](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L224)
___ ___
@@ -293,7 +311,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -314,7 +332,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim-item.ts:139](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim-item.ts#L139) [medusa/src/services/claim-item.ts:127](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim-item.ts#L127)
___ ___
@@ -338,4 +356,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ClaimService.md
+62 -43
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:89](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L89) [medusa/src/services/claim.ts:86](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L86)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### addressRepository\_ ### addressRepository\_
• `Protected` `Readonly` **addressRepository\_**: typeof `AddressRepository` • `Protected` `Readonly` **addressRepository\_**: `Repository`<`Address`\>
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L71) [medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L68)
___ ___
@@ -86,17 +86,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L75) [medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L72)
___ ___
### claimRepository\_ ### claimRepository\_
• `Protected` `Readonly` **claimRepository\_**: typeof `ClaimRepository` • `Protected` `Readonly` **claimRepository\_**: `Repository`<`ClaimOrder`\>
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L72) [medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L69)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L76) [medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L73)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L77) [medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L74)
___ ___
@@ -126,17 +126,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L78) [medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L75)
___ ___
### lineItemRepository\_ ### lineItemRepository\_
• `Protected` `Readonly` **lineItemRepository\_**: typeof `LineItemRepository` • `Protected` `Readonly` **lineItemRepository\_**: `Repository`<`LineItem`\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<`LineItem` & { `return_item`: `ReturnItem` }[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L74) [medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L71)
___ ___
@@ -146,7 +146,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L79) [medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L76)
___ ___
@@ -154,13 +154,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L68) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -170,7 +170,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L80) [medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L77)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:87](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L87) [medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L84)
___ ___
@@ -190,7 +190,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L81) [medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L78)
___ ___
@@ -200,17 +200,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L82) [medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L79)
___ ___
### shippingMethodRepository\_ ### shippingMethodRepository\_
• `Protected` `Readonly` **shippingMethodRepository\_**: typeof `ShippingMethodRepository` • `Protected` `Readonly` **shippingMethodRepository\_**: `Repository`<`ShippingMethod`\>
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L73) [medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L70)
___ ___
@@ -220,7 +220,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L83) [medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L80)
___ ___
@@ -230,7 +230,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L84) [medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L81)
___ ___
@@ -240,7 +240,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L85) [medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L82)
___ ___
@@ -248,13 +248,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L69) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -275,7 +275,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L59) [medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L59)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -314,7 +332,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -334,7 +352,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:810](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L810) [medusa/src/services/claim.ts:813](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L813)
___ ___
@@ -354,7 +372,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:658](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L658) [medusa/src/services/claim.ts:661](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L661)
___ ___
@@ -380,7 +398,7 @@ created claim
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:337](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L337) [medusa/src/services/claim.ts:331](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L331)
___ ___
@@ -394,6 +412,7 @@ ___
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | the object containing all data required to create a claim | | `id` | `string` | the object containing all data required to create a claim |
| `config` | `Object` | config object | | `config` | `Object` | config object |
| `config.location_id?` | `string` | - |
| `config.metadata?` | `Record`<`string`, `unknown`\> | config metadata | | `config.metadata?` | `Record`<`string`, `unknown`\> | config metadata |
| `config.no_notification?` | `boolean` | config no notification | | `config.no_notification?` | `boolean` | config no notification |
@@ -405,7 +424,7 @@ created claim
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:510](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L510) [medusa/src/services/claim.ts:512](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L512)
___ ___
@@ -430,7 +449,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:730](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L730) [medusa/src/services/claim.ts:733](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L733)
___ ___
@@ -460,7 +479,7 @@ the refund amount
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:279](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L279) [medusa/src/services/claim.ts:273](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L273)
___ ___
@@ -483,7 +502,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:866](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L866) [medusa/src/services/claim.ts:869](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L869)
___ ___
@@ -503,7 +522,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:684](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L684) [medusa/src/services/claim.ts:687](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L687)
___ ___
@@ -528,7 +547,7 @@ the order document
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:886](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L886) [medusa/src/services/claim.ts:888](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L888)
___ ___
@@ -552,7 +571,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -573,7 +592,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:131](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L131) [medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L125)
___ ___
@@ -593,7 +612,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/claim.ts:212](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/claim.ts#L212) [medusa/src/services/claim.ts:206](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/claim.ts#L206)
___ ___
@@ -617,4 +636,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/CurrencyService.md
+37 -19
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L32) [medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L29)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### currencyRepository\_ ### currencyRepository\_
• `Protected` `Readonly` **currencyRepository\_**: typeof `CurrencyRepository` • `Protected` `Readonly` **currencyRepository\_**: `Repository`<`Currency`\>
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L28) [medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L25)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L29) [medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L26)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L30) [medusa/src/services/currency.ts:27](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L27)
___ ___
@@ -104,13 +104,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L25) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -118,13 +118,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L26) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -140,7 +140,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L21) [medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L21)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -179,7 +197,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -207,7 +225,7 @@ an array containing the currencies as
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L81) [medusa/src/services/currency.ts:78](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L78)
___ ___
@@ -231,7 +249,7 @@ The currency
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L50) [medusa/src/services/currency.ts:47](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L47)
___ ___
@@ -255,7 +273,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -280,7 +298,7 @@ The updated currency
#### Defined in #### Defined in
[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/currency.ts#L103) [medusa/src/services/currency.ts:100](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/currency.ts#L100)
___ ___
@@ -304,4 +322,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/CustomShippingOptionService.md
+34 -16
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/custom-shipping-option.ts#L20) [medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/custom-shipping-option.ts#L18)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### customShippingOptionRepository\_ ### customShippingOptionRepository\_
• `Protected` **customShippingOptionRepository\_**: typeof `CustomShippingOptionRepository` • `Protected` **customShippingOptionRepository\_**: `Repository`<`CustomShippingOption`\>
#### Defined in #### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/custom-shipping-option.ts#L18) [medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/custom-shipping-option.ts#L16)
___ ___
@@ -84,13 +84,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/custom-shipping-option.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -98,13 +98,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/custom-shipping-option.ts#L16) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -143,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -174,7 +192,7 @@ resolves to the creation result
#### Defined in #### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/custom-shipping-option.ts#L89) [medusa/src/services/custom-shipping-option.ts:80](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/custom-shipping-option.ts#L80)
___ ___
@@ -199,7 +217,7 @@ custom shipping options matching the query
#### Defined in #### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/custom-shipping-option.ts#L65) [medusa/src/services/custom-shipping-option.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/custom-shipping-option.ts#L58)
___ ___
@@ -224,7 +242,7 @@ the requested custom shipping option.
#### Defined in #### Defined in
[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/custom-shipping-option.ts#L37) [medusa/src/services/custom-shipping-option.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/custom-shipping-option.ts#L31)
___ ___
@@ -248,7 +266,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -272,4 +290,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/CustomerGroupService.md
+42 -32
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L27) [medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L24)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### customerGroupRepository\_ ### customerGroupRepository\_
• `Protected` `Readonly` **customerGroupRepository\_**: typeof `CustomerGroupRepository` • `Protected` `Readonly` **customerGroupRepository\_**: `Repository`<`CustomerGroup`\> & { `addCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<`CustomerGroup`\> ; `findWithRelationsAndCount`: (`relations`: `FindOptionsRelations`<`CustomerGroup`\>, `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`CustomerGroup`[], `number`]\> ; `removeCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<`DeleteResult`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L24) [medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L21)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L25) [medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L22)
___ ___
@@ -94,13 +94,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L21) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -108,13 +108,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L22) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -139,7 +157,7 @@ the customer group after insertion
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:94](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L94) [medusa/src/services/customer-group.ts:89](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L89)
___ ___
@@ -178,7 +196,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -192,15 +210,7 @@ Creates a customer group with the provided data.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `group` | `Object` | the customer group to create | | `group` | `DeepPartial`<`CustomerGroup`\> | the customer group to create |
| `group.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `group.customers?` | (`undefined` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef...)[] | - |
| `group.deleted_at?` | ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `group.id?` | `string` | - |
| `group.metadata?` | { [x: string]: unknown; } | - |
| `group.name?` | `string` | - |
| `group.price_lists?` | (`undefined` \| { name?: string \| undefined; description?: string \| undefined; type?: PriceListType \| undefined; status?: PriceListStatus \| undefined; starts\_at?: { ...; } \| ... 1 more ... \| undefined; ... 7 more ...; updated\_at?: { ...; } \| undefined; })[] | - |
| `group.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
#### Returns #### Returns
@@ -210,7 +220,7 @@ the result of the create operation
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:70](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L70) [medusa/src/services/customer-group.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L65)
___ ___
@@ -234,7 +244,7 @@ a promise
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:158](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L158) [medusa/src/services/customer-group.ts:153](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L153)
___ ___
@@ -256,7 +266,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:261](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L261) [medusa/src/services/customer-group.ts:257](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L257)
___ ___
@@ -281,7 +291,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:181](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L181) [medusa/src/services/customer-group.ts:176](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L176)
___ ___
@@ -306,7 +316,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:199](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L199) [medusa/src/services/customer-group.ts:194](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L194)
___ ___
@@ -331,7 +341,7 @@ the customergroup with the provided id
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:240](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L240) [medusa/src/services/customer-group.ts:236](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L236)
___ ___
@@ -352,7 +362,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L40) [medusa/src/services/customer-group.ts:35](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L35)
___ ___
@@ -376,7 +386,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -401,7 +411,7 @@ resulting customer group
#### Defined in #### Defined in
[packages/medusa/src/services/customer-group.ts:125](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer-group.ts#L125) [medusa/src/services/customer-group.ts:120](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer-group.ts#L120)
___ ___
@@ -425,4 +435,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/CustomerService.md
+59 -41
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L39) [medusa/src/services/customer.ts:46](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L46)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,27 +68,27 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### addressRepository\_ ### addressRepository\_
• `Protected` `Readonly` **addressRepository\_**: typeof `AddressRepository` • `Protected` `Readonly` **addressRepository\_**: `Repository`<`Address`\>
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L27) [medusa/src/services/customer.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L37)
___ ___
### customerRepository\_ ### customerRepository\_
• `Protected` `Readonly` **customerRepository\_**: typeof `CustomerRepository` • `Protected` `Readonly` **customerRepository\_**: `Repository`<`Customer`\> & { `listAndCount`: (`query`: `Omit`<`FindOneOptions`<`Customer`\>, ``"where"`` \| ``"select"`` \| ``"relations"``\> & { `order?`: `FindOptionsOrder`<`Customer`\> ; `relations?`: `FindOptionsRelations`<`Customer`\> ; `select?`: `FindOptionsSelect`<`Customer`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`Customer`\> \| `FindOptionsWhere`<`Customer`\>[] } & { `where`: `FindOptionsWhere`<`Customer` & { `groups?`: `FindOperator`<`string`[]\> }\> } & `Omit`<`FindManyOptions`<`Customer`\>, ``"where"`` \| ``"select"`` \| ``"relations"``\> & { `order?`: `FindOptionsOrder`<`Customer`\> ; `relations?`: `FindOptionsRelations`<`Customer`\> ; `select?`: `FindOptionsSelect`<`Customer`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`Customer`\> \| `FindOptionsWhere`<`Customer`\>[] } & { `where`: `FindOptionsWhere`<`Customer` & { `groups?`: `FindOperator`<`string`[]\> }\> }, `q`: `undefined` \| `string`) => `Promise`<[`Customer`[], `number`]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L26) [medusa/src/services/customer.ts:36](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L36)
___ ___
@@ -98,35 +98,35 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L28) [medusa/src/services/customer.ts:38](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L38)
___ ___
### manager\_ ### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L30) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### transactionManager\_ ### transactionManager\_
• `Protected` `Readonly` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -144,7 +144,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L33) [medusa/src/services/customer.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L40)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -165,7 +183,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:498](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L498) [medusa/src/services/customer.ts:519](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L519)
___ ___
@@ -204,7 +222,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -222,7 +240,7 @@ the result of the count operation
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L158) [medusa/src/services/customer.ts:178](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L178)
___ ___
@@ -249,7 +267,7 @@ the result of create
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:285](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L285) [medusa/src/services/customer.ts:306](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L306)
___ ___
@@ -273,7 +291,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:546](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L546) [medusa/src/services/customer.ts:565](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L565)
___ ___
@@ -301,7 +319,7 @@ the generated JSON web token
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L64) [medusa/src/services/customer.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L68)
___ ___
@@ -325,7 +343,7 @@ hashed password
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:272](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L272) [medusa/src/services/customer.ts:293](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L293)
___ ___
@@ -337,7 +355,7 @@ ___
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find | | `selector` | `Selector`<`Customer`\> & { `groups?`: `string`[] ; `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings | | `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns #### Returns
@@ -348,7 +366,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L107) [medusa/src/services/customer.ts:111](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L111)
___ ___
@@ -360,7 +378,7 @@ ___
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find | | `selector` | `Selector`<`Customer`\> & { `groups?`: `string`[] ; `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings | | `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns #### Returns
@@ -371,7 +389,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L131) [medusa/src/services/customer.ts:143](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L143)
___ ___
@@ -392,7 +410,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:228](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L228) [medusa/src/services/customer.ts:249](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L249)
___ ___
@@ -413,7 +431,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:481](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L481) [medusa/src/services/customer.ts:502](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L502)
___ ___
@@ -438,7 +456,7 @@ the customer document.
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:253](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L253) [medusa/src/services/customer.ts:274](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L274)
___ ___
@@ -465,7 +483,7 @@ the customer document.
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:195](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L195) [medusa/src/services/customer.ts:216](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L216)
___ ___
@@ -490,7 +508,7 @@ the customer document.
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:240](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L240) [medusa/src/services/customer.ts:261](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L261)
___ ___
@@ -511,7 +529,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:218](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L218) [medusa/src/services/customer.ts:239](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L239)
___ ___
@@ -532,7 +550,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:209](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L209) [medusa/src/services/customer.ts:230](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L230)
___ ___
@@ -553,7 +571,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L164) [medusa/src/services/customer.ts:185](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L185)
___ ___
@@ -577,7 +595,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -602,7 +620,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:341](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L341) [medusa/src/services/customer.ts:362](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L362)
___ ___
@@ -624,7 +642,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:453](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L453) [medusa/src/services/customer.ts:474](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L474)
___ ___
@@ -639,7 +657,7 @@ Updates the customers' billing address.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `customer` | `Customer` | the Customer to update | | `customer` | `Customer` | the Customer to update |
| `addressOrId` | `undefined` \| `string` \| { `address_1?`: ``null`` \| `string` ; `address_2?`: ``null`` \| `string` ; `city?`: ``null`` \| `string` ; `company?`: ``null`` \| `string` ; `country?`: ``null`` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; } ; `country_code?`: ``null`` \| `string` ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `customer?`: ``null`` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef... ; `customer_id?`: ``null`` \| `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `first_name?`: ``null`` \| `string` ; `id?`: `string` ; `last_name?`: ``null`` \| `string` ; `metadata?`: { [x: string]: unknown; } ; `phone?`: ``null`` \| `string` ; `postal_code?`: ``null`` \| `string` ; `province?`: ``null`` \| `string` ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } } | the value to set the billing address to | | `addressOrId` | `undefined` \| `string` \| `DeepPartial`<`Address`\> | the value to set the billing address to |
#### Returns #### Returns
@@ -649,7 +667,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/customer.ts:401](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/customer.ts#L401) [medusa/src/services/customer.ts:422](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/customer.ts#L422)
___ ___
@@ -673,4 +691,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/DiscountConditionService.md
+37 -19
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L37) [medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L34)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,17 +70,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### discountConditionRepository\_ ### discountConditionRepository\_
• `Protected` `Readonly` **discountConditionRepository\_**: typeof `DiscountConditionRepository` • `Protected` `Readonly` **discountConditionRepository\_**: `Repository`<`DiscountCondition`\> & { `addConditionResources`: (`conditionId`: `string`, `resourceIds`: (`string` \| { `id`: `string` })[], `type`: `DiscountConditionType`, `overrideExisting`: `boolean`) => `Promise`<(`DiscountConditionProduct` \| `DiscountConditionProductType` \| `DiscountConditionProductCollection` \| `DiscountConditionProductTag` \| `DiscountConditionCustomerGroup`)[]\> ; `canApplyForCustomer`: (`discountRuleId`: `string`, `customerId`: `string`) => `Promise`<`boolean`\> ; `findOneWithDiscount`: (`conditionId`: `string`, `discountId`: `string`) => `Promise`<`undefined` \| `DiscountCondition` & { `discount`: `Discount` }\> ; `getJoinTableResourceIdentifiers`: (`type`: `string`) => { `conditionTable`: `DiscountConditionResourceType` ; `joinTable`: `string` ; `joinTableForeignKey`: `DiscountConditionJoinTableForeignKey` ; `joinTableKey`: `string` ; `resourceKey`: `string` } ; `isValidForProduct`: (`discountRuleId`: `string`, `productId`: `string`) => `Promise`<`boolean`\> ; `queryConditionTable`: (`__namedParameters`: `Object`) => `Promise`<`number`\> ; `removeConditionResources`: (`id`: `string`, `type`: `DiscountConditionType`, `resourceIds`: (`string` \| { `id`: `string` })[]) => `Promise`<`void` \| `DeleteResult`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L31) [medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L31)
___ ___
@@ -90,7 +90,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L32) [medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L32)
___ ___
@@ -98,13 +98,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L34) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -112,13 +112,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L35) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -157,7 +175,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -177,7 +195,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:220](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L220) [medusa/src/services/discount-condition.ts:217](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L217)
___ ___
@@ -197,7 +215,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:188](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L188) [medusa/src/services/discount-condition.ts:184](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L184)
___ ___
@@ -218,7 +236,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L49) [medusa/src/services/discount-condition.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L45)
___ ___
@@ -242,7 +260,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -263,7 +281,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:116](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L116) [medusa/src/services/discount-condition.ts:111](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L111)
___ ___
@@ -287,7 +305,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -307,4 +325,4 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount-condition.ts:79](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount-condition.ts#L79) [medusa/src/services/discount-condition.ts:74](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount-condition.ts#L74)
docs/content/references/services/classes/DiscountService.md
+67 -49
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L69) [medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L65)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,17 +80,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L56) [medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L52)
___ ___
### discountConditionRepository\_ ### discountConditionRepository\_
• `Protected` `Readonly` **discountConditionRepository\_**: typeof `DiscountConditionRepository` • `Protected` `Readonly` **discountConditionRepository\_**: `Repository`<`DiscountCondition`\> & { `addConditionResources`: (`conditionId`: `string`, `resourceIds`: (`string` \| { `id`: `string` })[], `type`: `DiscountConditionType`, `overrideExisting`: `boolean`) => `Promise`<(`DiscountConditionProduct` \| `DiscountConditionProductType` \| `DiscountConditionProductCollection` \| `DiscountConditionProductTag` \| `DiscountConditionCustomerGroup`)[]\> ; `canApplyForCustomer`: (`discountRuleId`: `string`, `customerId`: `string`) => `Promise`<`boolean`\> ; `findOneWithDiscount`: (`conditionId`: `string`, `discountId`: `string`) => `Promise`<`undefined` \| `DiscountCondition` & { `discount`: `Discount` }\> ; `getJoinTableResourceIdentifiers`: (`type`: `string`) => { `conditionTable`: `DiscountConditionResourceType` ; `joinTable`: `string` ; `joinTableForeignKey`: `DiscountConditionJoinTableForeignKey` ; `joinTableKey`: `string` ; `resourceKey`: `string` } ; `isValidForProduct`: (`discountRuleId`: `string`, `productId`: `string`) => `Promise`<`boolean`\> ; `queryConditionTable`: (`__namedParameters`: `Object`) => `Promise`<`number`\> ; `removeConditionResources`: (`id`: `string`, `type`: `DiscountConditionType`, `resourceIds`: (`string` \| { `id`: `string` })[]) => `Promise`<`void` \| `DeleteResult`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L60) [medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L56)
___ ___
@@ -100,27 +100,27 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L61) [medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L57)
___ ___
### discountRepository\_ ### discountRepository\_
• `Protected` `Readonly` **discountRepository\_**: typeof `DiscountRepository` • `Protected` `Readonly` **discountRepository\_**: `Repository`<`Discount`\>
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L55) [medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L51)
___ ___
### discountRuleRepository\_ ### discountRuleRepository\_
• `Protected` `Readonly` **discountRuleRepository\_**: typeof `DiscountRuleRepository` • `Protected` `Readonly` **discountRuleRepository\_**: `Repository`<`DiscountRule`\>
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L57) [medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L53)
___ ___
@@ -130,7 +130,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L66) [medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L62)
___ ___
@@ -140,17 +140,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L67) [medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L63)
___ ___
### giftCardRepository\_ ### giftCardRepository\_
• `Protected` `Readonly` **giftCardRepository\_**: typeof `GiftCardRepository` • `Protected` `Readonly` **giftCardRepository\_**: `Repository`<`GiftCard`\> & { `listGiftCardsAndCount`: (`query`: `ExtendedFindConfig`<`GiftCard`\>, `q?`: `string`) => `Promise`<[`GiftCard`[], `number`]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L58) [medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L54)
___ ___
@@ -158,13 +158,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L52) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -174,7 +174,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L63) [medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L59)
___ ___
@@ -184,7 +184,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L64) [medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L60)
___ ___
@@ -194,7 +194,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L65) [medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L61)
___ ___
@@ -204,7 +204,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L62) [medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L58)
___ ___
@@ -212,13 +212,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L53) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -243,7 +261,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:513](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L513) [medusa/src/services/discount.ts:497](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L497)
___ ___
@@ -282,7 +300,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -304,7 +322,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:614](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L614) [medusa/src/services/discount.ts:599](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L599)
___ ___
@@ -325,7 +343,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:791](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L791) [medusa/src/services/discount.ts:778](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L778)
___ ___
@@ -350,7 +368,7 @@ the result of the create operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:187](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L187) [medusa/src/services/discount.ts:172](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L172)
___ ___
@@ -375,7 +393,7 @@ the newly created dynamic code
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:441](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L441) [medusa/src/services/discount.ts:425](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L425)
___ ___
@@ -399,7 +417,7 @@ the result of the delete operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L573) [medusa/src/services/discount.ts:557](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L557)
___ ___
@@ -424,7 +442,7 @@ the newly created dynamic code
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:492](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L492) [medusa/src/services/discount.ts:476](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L476)
___ ___
@@ -444,7 +462,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:760](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L760) [medusa/src/services/discount.ts:747](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L747)
___ ___
@@ -464,7 +482,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:756](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L756) [medusa/src/services/discount.ts:743](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L743)
___ ___
@@ -484,7 +502,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:750](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L750) [medusa/src/services/discount.ts:737](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L737)
___ ___
@@ -504,7 +522,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:768](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L768) [medusa/src/services/discount.ts:755](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L755)
___ ___
@@ -525,7 +543,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:772](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L772) [medusa/src/services/discount.ts:759](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L759)
___ ___
@@ -548,7 +566,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L125) [medusa/src/services/discount.ts:119](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L119)
___ ___
@@ -571,7 +589,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:141](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L141) [medusa/src/services/discount.ts:136](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L136)
___ ___
@@ -596,7 +614,7 @@ the discounts
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:314](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L314) [medusa/src/services/discount.ts:301](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L301)
___ ___
@@ -621,7 +639,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:548](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L548) [medusa/src/services/discount.ts:532](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L532)
___ ___
@@ -646,7 +664,7 @@ the discount
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:253](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L253) [medusa/src/services/discount.ts:238](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L238)
___ ___
@@ -671,7 +689,7 @@ the discount
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:286](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L286) [medusa/src/services/discount.ts:272](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L272)
___ ___
@@ -695,7 +713,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -720,7 +738,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:344](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L344) [medusa/src/services/discount.ts:332](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L332)
___ ___
@@ -741,7 +759,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:685](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L685) [medusa/src/services/discount.ts:672](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L672)
___ ___
@@ -762,7 +780,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:587](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L587) [medusa/src/services/discount.ts:571](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L571)
___ ___
@@ -792,7 +810,7 @@ the result of the create operation
#### Defined in #### Defined in
[packages/medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/discount.ts#L107) [medusa/src/services/discount.ts:101](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/discount.ts#L101)
___ ___
@@ -816,4 +834,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/DraftOrderService.md
+50 -32
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:61](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L61) [medusa/src/services/draft-order.ts:66](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L66)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L55) [medusa/src/services/draft-order.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L60)
___ ___
@@ -90,17 +90,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L59) [medusa/src/services/draft-order.ts:64](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L64)
___ ___
### draftOrderRepository\_ ### draftOrderRepository\_
• `Protected` `Readonly` **draftOrderRepository\_**: typeof `DraftOrderRepository` • `Protected` `Readonly` **draftOrderRepository\_**: `Repository`<`DraftOrder`\>
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L51) [medusa/src/services/draft-order.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L56)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L54) [medusa/src/services/draft-order.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L59)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L56) [medusa/src/services/draft-order.ts:61](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L61)
___ ___
@@ -128,33 +128,33 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L48) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### orderRepository\_ ### orderRepository\_
• `Protected` `Readonly` **orderRepository\_**: typeof `OrderRepository` • `Protected` `Readonly` **orderRepository\_**: `Repository`<`Order`\> & { `findOneWithRelations`: (`relations`: `FindOptionsRelations`<`Order`\>, `optionsWithoutRelations`: `Omit`<`FindManyOptions`<`Order`\>, ``"relations"``\>) => `Promise`<`Order`\> ; `findWithRelations`: (`relations`: `FindOptionsRelations`<`Order`\>, `optionsWithoutRelations`: `Omit`<`FindManyOptions`<`Order`\>, ``"relations"``\>) => `Promise`<`Order`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L53) [medusa/src/services/draft-order.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L58)
___ ___
### paymentRepository\_ ### paymentRepository\_
• `Protected` `Readonly` **paymentRepository\_**: typeof `PaymentRepository` • `Protected` `Readonly` **paymentRepository\_**: `Repository`<`Payment`\>
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L52) [medusa/src/services/draft-order.ts:57](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L57)
___ ___
@@ -164,7 +164,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L57) [medusa/src/services/draft-order.ts:62](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L62)
___ ___
@@ -174,7 +174,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:58](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L58) [medusa/src/services/draft-order.ts:63](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L63)
___ ___
@@ -182,13 +182,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L49) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -205,7 +205,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L43) [medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L51)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -244,7 +262,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -268,7 +286,7 @@ the created draft order
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:255](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L255) [medusa/src/services/draft-order.ts:259](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L259)
___ ___
@@ -292,7 +310,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:154](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L154) [medusa/src/services/draft-order.ts:155](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L155)
___ ___
@@ -317,7 +335,7 @@ list of draft orders
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:232](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L232) [medusa/src/services/draft-order.ts:237](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L237)
___ ___
@@ -342,7 +360,7 @@ draft orders
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:178](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L178) [medusa/src/services/draft-order.ts:179](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L179)
___ ___
@@ -367,7 +385,7 @@ the created order
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:416](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L416) [medusa/src/services/draft-order.ts:420](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L420)
___ ___
@@ -392,7 +410,7 @@ the draft order
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:94](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L94) [medusa/src/services/draft-order.ts:97](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L97)
___ ___
@@ -417,7 +435,7 @@ the draft order
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:128](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L128) [medusa/src/services/draft-order.ts:130](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L130)
___ ___
@@ -441,7 +459,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -467,7 +485,7 @@ the updated draft order
#### Defined in #### Defined in
[packages/medusa/src/services/draft-order.ts:445](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/draft-order.ts#L445) [medusa/src/services/draft-order.ts:449](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/draft-order.ts#L449)
___ ___
@@ -491,4 +509,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/EventBusService.md
+177 -125
View File
@@ -3,33 +3,89 @@
Can keep track of multiple subscribers to different events and run the Can keep track of multiple subscribers to different events and run the
subscribers when events happen. Events will run asynchronously. subscribers when events happen. Events will run asynchronously.
## Hierarchy
- `TransactionBaseService`
↳ **`EventBusService`**
## Implements
- `IEventBusService`
## Constructors ## Constructors
### constructor ### constructor
• **new EventBusService**(`__namedParameters`, `config`, `singleton?`) • **new EventBusService**(`__namedParameters`, `config`, `isSingleton?`)
#### Parameters #### Parameters
| Name | Type | Default value | | Name | Type | Default value |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | `undefined` | | `__namedParameters` | `InjectedDependencies` | `undefined` |
| `config` | `ConfigModule` | `undefined` | | `config` | `any` | `undefined` |
| `singleton` | `boolean` | `true` | | `isSingleton` | `boolean` | `true` |
#### Overrides
TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:80](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L80) [medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L32)
## Properties ## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### config\_ ### config\_
• `Protected` `Readonly` **config\_**: `ConfigModule` • `Protected` `Readonly` **config\_**: `ConfigModule`
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L64) [medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L24)
___ ___
@@ -39,77 +95,31 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:78](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L78) [medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L30)
___ ___
### eventToSubscribersMap\_ ### eventBusModuleService\_
• `Protected` `Readonly` **eventToSubscribersMap\_**: `Map`<`string` \| `symbol`, `SubscriberDescriptor`[]\> • `Protected` `Readonly` **eventBusModuleService\_**: `AbstractEventBusModuleService`
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L69) [medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L27)
___
### jobSchedulerService\_
• `Protected` `Readonly` **jobSchedulerService\_**: `default`
#### Defined in
[packages/medusa/src/services/event-bus.ts:68](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L68)
___
### logger\_
• `Protected` `Readonly` **logger\_**: `Logger`
#### Defined in
[packages/medusa/src/services/event-bus.ts:66](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L66)
___ ___
### manager\_ ### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Inherited from
TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L65) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### queue\_
• `Protected` **queue\_**: `Bull`
#### Defined in
[packages/medusa/src/services/event-bus.ts:75](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L75)
___
### redisClient\_
• `Protected` `Readonly` **redisClient\_**: `Redis`
#### Defined in
[packages/medusa/src/services/event-bus.ts:73](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L73)
___
### redisSubscriber\_
• `Protected` `Readonly` **redisSubscriber\_**: `Redis`
#### Defined in
[packages/medusa/src/services/event-bus.ts:74](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L74)
___ ___
@@ -119,17 +129,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:76](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L76) [medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L29)
___ ___
### stagedJobRepository\_ ### stagedJobService\_
• `Protected` `Readonly` **stagedJobRepository\_**: typeof `StagedJobRepository` • `Protected` `Readonly` **stagedJobService\_**: [`StagedJobService`](StagedJobService.md)
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L67) [medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L25)
___ ___
@@ -137,47 +147,70 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:77](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L77) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
### createCronJob ### atomicPhase\_
▸ **createCronJob**<`T`\>(`eventName`, `data`, `cron`, `handler`, `options?`): `Promise`<`void`\> ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Registers a cron job. Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
**`Deprecated`** transaction manager is created.
All cron job logic has been refactored to the `JobSchedulerService`. This method will be removed in a future release.
#### Type parameters #### Type parameters
| Name | | Name |
| :------ | | :------ |
| `T` | | `TResult` |
| `TError` |
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `eventName` | `string` | the name of the event | | `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `data` | `T` | the data to be sent with the event | | `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `cron` | `string` | the cron pattern | | `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
| `handler` | `Subscriber`<`unknown`\> | the handler to call on each cron job |
| `options?` | `CreateJobOptions` | - |
#### Returns #### Returns
`Promise`<`void`\> `Promise`<`TResult`\>
void the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:467](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L467) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -205,9 +238,13 @@ Calls all subscribers when an event occurs.
the jobs from our queue the jobs from our queue
#### Implementation of
EventBusTypes.IEventBusService.emit
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:228](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L228) [medusa/src/services/event-bus.ts:112](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L112)
▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\> ▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\>
@@ -225,7 +262,7 @@ Calls all subscribers when an event occurs.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `eventName` | `string` | the name of the event to be process. | | `eventName` | `string` | the name of the event to be process. |
| `data` | `T` | the data to send to the subscriber. | | `data` | `T` | the data to send to the subscriber. |
| `options?` | `any` | options to add the job with | | `options?` | `Record`<`string`, `unknown`\> | options to add the job with |
#### Returns #### Returns
@@ -233,9 +270,13 @@ Calls all subscribers when an event occurs.
the job from our queue the job from our queue
#### Implementation of
EventBusTypes.IEventBusService.emit
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:237](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L237) [medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L121)
___ ___
@@ -249,7 +290,31 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:326](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L326) [medusa/src/services/event-bus.ts:184](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L184)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -263,7 +328,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:316](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L316) [medusa/src/services/event-bus.ts:174](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L174)
___ ___
@@ -277,7 +342,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:321](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L321) [medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L179)
___ ___
@@ -292,8 +357,8 @@ Adds a function to a list of event subscribers.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `event` | `string` \| `symbol` | the event that the subscriber will listen for. | | `event` | `string` \| `symbol` | the event that the subscriber will listen for. |
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event | | `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. |
| `context?` | `SubscriberContext` | context to use when attaching subscriber happens. Subscribers must return a Promise. | | `context?` | `SubscriberContext` | subscriber context |
#### Returns #### Returns
@@ -301,24 +366,29 @@ Adds a function to a list of event subscribers.
this this
#### Implementation of
EventBusTypes.IEventBusService.subscribe
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:160](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L160) [medusa/src/services/event-bus.ts:78](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L78)
___ ___
### unsubscribe ### unsubscribe
▸ **unsubscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md) ▸ **unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers. Removes function from the list of event subscribers.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `event` | `string` \| `symbol` | the event that the subscriber will listen for. | | `event` | `string` \| `symbol` | the event of the subcriber. |
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. | | `subscriber` | `Subscriber`<`unknown`\> | the function to be removed |
| `context` | `SubscriberContext` | subscriber context |
#### Returns #### Returns
@@ -326,56 +396,38 @@ Adds a function to a list of event subscribers.
this this
#### Implementation of
EventBusTypes.IEventBusService.unsubscribe
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:203](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L203) [medusa/src/services/event-bus.ts:98](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L98)
___ ___
### withTransaction ### withTransaction
▸ **withTransaction**(`transactionManager`): [`EventBusService`](EventBusService.md) ▸ **withTransaction**(`transactionManager?`): [`EventBusService`](EventBusService.md)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `transactionManager` | `any` | | `transactionManager?` | `EntityManager` |
#### Returns #### Returns
[`EventBusService`](EventBusService.md) [`EventBusService`](EventBusService.md)
#### Defined in #### Implementation of
[packages/medusa/src/services/event-bus.ts:128](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L128) EventBusTypes.IEventBusService.withTransaction
___ #### Overrides
### worker\_ TransactionBaseService.withTransaction
▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`\>
Handles incoming jobs.
#### Type parameters
| Name |
| :------ |
| `T` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `job` | `BullJob`<`T`\> | The job object |
#### Returns
`Promise`<`unknown`\>
resolves to the results of the subscriber calls.
#### Defined in #### Defined in
[packages/medusa/src/services/event-bus.ts:366](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/event-bus.ts#L366) [medusa/src/services/event-bus.ts:49](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/event-bus.ts#L49)
docs/content/references/services/classes/FulfillmentProviderService.md
+45 -27
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L47) [medusa/src/services/fulfillment-provider.ts:44](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L44)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,17 +78,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L43) [medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L40)
___ ___
### fulfillmentProviderRepository\_ ### fulfillmentProviderRepository\_
• `Protected` `Readonly` **fulfillmentProviderRepository\_**: typeof `FulfillmentProviderRepository` • `Protected` `Readonly` **fulfillmentProviderRepository\_**: `Repository`<`FulfillmentProvider`\>
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L45) [medusa/src/services/fulfillment-provider.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L42)
___ ___
@@ -96,13 +96,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L40) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,13 +110,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L41) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -155,7 +173,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -169,7 +187,7 @@ ___
| :------ | :------ | | :------ | :------ |
| `option` | `ShippingOption` | | `option` | `ShippingOption` |
| `data` | `Record`<`string`, `unknown`\> | | `data` | `Record`<`string`, `unknown`\> |
| `cart?` | `Cart` \| `Order` | | `cart?` | `Order` \| `Cart` |
#### Returns #### Returns
@@ -177,7 +195,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:151](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L151) [medusa/src/services/fulfillment-provider.ts:147](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L147)
___ ___
@@ -197,7 +215,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:126](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L126) [medusa/src/services/fulfillment-provider.ts:122](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L122)
___ ___
@@ -217,7 +235,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:144](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L144) [medusa/src/services/fulfillment-provider.ts:140](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L140)
___ ___
@@ -240,7 +258,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:111](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L111) [medusa/src/services/fulfillment-provider.ts:107](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L107)
___ ___
@@ -260,7 +278,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:169](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L169) [medusa/src/services/fulfillment-provider.ts:165](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L165)
___ ___
@@ -274,7 +292,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:71](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L71) [medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L67)
___ ___
@@ -294,7 +312,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:79](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L79) [medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L75)
___ ___
@@ -314,7 +332,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L57) [medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L53)
___ ___
@@ -340,7 +358,7 @@ document to fetch
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:188](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L188) [medusa/src/services/fulfillment-provider.ts:184](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L184)
___ ___
@@ -362,7 +380,7 @@ the payment fulfillment provider
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:100](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L100) [medusa/src/services/fulfillment-provider.ts:96](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L96)
___ ___
@@ -386,7 +404,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -408,7 +426,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:131](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L131) [medusa/src/services/fulfillment-provider.ts:127](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L127)
___ ___
@@ -428,7 +446,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment-provider.ts:164](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment-provider.ts#L164) [medusa/src/services/fulfillment-provider.ts:160](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment-provider.ts#L160)
___ ___
@@ -452,4 +470,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/FulfillmentService.md
+48 -32
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L50) [medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L47)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,27 +78,27 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L43) [medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L40)
___ ___
### fulfillmentRepository\_ ### fulfillmentRepository\_
• `Protected` `Readonly` **fulfillmentRepository\_**: typeof `FulfillmentRepository` • `Protected` `Readonly` **fulfillmentRepository\_**: `Repository`<`Fulfillment`\>
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L44) [medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L41)
___ ___
### lineItemRepository\_ ### lineItemRepository\_
• `Protected` `Readonly` **lineItemRepository\_**: typeof `LineItemRepository` • `Protected` `Readonly` **lineItemRepository\_**: `Repository`<`LineItem`\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<`LineItem` & { `return_item`: `ReturnItem` }[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L46) [medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L43)
___ ___
@@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L41) [medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L38)
___ ___
@@ -116,13 +116,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L48) [medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L45)
___ ___
@@ -142,7 +142,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L42) [medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L39)
___ ___
@@ -152,17 +152,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L40) [medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L37)
___ ___
### trackingLinkRepository\_ ### trackingLinkRepository\_
• `Protected` `Readonly` **trackingLinkRepository\_**: typeof `TrackingLinkRepository` • `Protected` `Readonly` **trackingLinkRepository\_**: `Repository`<`TrackingLink`\>
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L45) [medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L42)
___ ___
@@ -170,13 +170,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L38) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -215,7 +233,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -241,13 +259,13 @@ the result of the save operation
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:269](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L269) [medusa/src/services/fulfillment.ts:260](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L260)
___ ___
### createFulfillment ### createFulfillment
▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`, `context?`): `Promise`<`Fulfillment`[]\> ▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<`Fulfillment`[]\>
Creates an order fulfillment Creates an order fulfillment
If items needs to be fulfilled by different provider, we make If items needs to be fulfilled by different provider, we make
@@ -261,8 +279,6 @@ those partitions.
| `order` | `CreateFulfillmentOrder` | order to create fulfillment for | | `order` | `CreateFulfillmentOrder` | order to create fulfillment for |
| `itemsToFulfill` | `FulFillmentItemType`[] | the items in the order to fulfill | | `itemsToFulfill` | `FulFillmentItemType`[] | the items in the order to fulfill |
| `custom` | `Partial`<`Fulfillment`\> | potential custom values to add | | `custom` | `Partial`<`Fulfillment`\> | potential custom values to add |
| `context` | `Object` | - |
| `context.locationId?` | `string` | - |
#### Returns #### Returns
@@ -272,7 +288,7 @@ the created fulfillments
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:211](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L211) [medusa/src/services/fulfillment.ts:205](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L205)
___ ___
@@ -299,7 +315,7 @@ the shipped fulfillment
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:321](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L321) [medusa/src/services/fulfillment.ts:312](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L312)
___ ___
@@ -324,7 +340,7 @@ the line items generated by the transformer.
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:115](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L115) [medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L109)
___ ___
@@ -345,7 +361,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L76) [medusa/src/services/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L70)
___ ___
@@ -370,7 +386,7 @@ the fulfillment
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:172](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L172) [medusa/src/services/fulfillment.ts:167](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L167)
___ ___
@@ -394,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -423,7 +439,7 @@ a line item that has the requested fulfillment quantity
#### Defined in #### Defined in
[packages/medusa/src/services/fulfillment.ts:140](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/fulfillment.ts#L140) [medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/fulfillment.ts#L134)
___ ___
@@ -447,4 +463,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/GiftCardService.md
+47 -29
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L47) [medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L39)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,27 +78,27 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L38) [medusa/src/services/gift-card.ts:33](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L33)
___ ___
### giftCardRepository\_ ### giftCardRepository\_
• `Protected` `Readonly` **giftCardRepository\_**: typeof `GiftCardRepository` • `Protected` `Readonly` **giftCardRepository\_**: `Repository`<`GiftCard`\> & { `listGiftCardsAndCount`: (`query`: `ExtendedFindConfig`<`GiftCard`\>, `q?`: `string`) => `Promise`<[`GiftCard`[], `number`]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L34) [medusa/src/services/gift-card.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L29)
___ ___
### giftCardTransactionRepo\_ ### giftCardTransactionRepo\_
• `Protected` `Readonly` **giftCardTransactionRepo\_**: typeof `GiftCardTransactionRepository` • `Protected` `Readonly` **giftCardTransactionRepo\_**: `Repository`<`GiftCardTransaction`\>
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L36) [medusa/src/services/gift-card.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L31)
___ ___
@@ -106,13 +106,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L40) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L37) [medusa/src/services/gift-card.ts:32](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L32)
___ ___
@@ -130,13 +130,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L41) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -152,7 +152,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L43) [medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L35)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -191,7 +209,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -215,7 +233,7 @@ the result of the create operation
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L153) [medusa/src/services/gift-card.ts:122](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L122)
___ ___
@@ -235,7 +253,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L138) [medusa/src/services/gift-card.ts:106](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L106)
___ ___
@@ -259,7 +277,7 @@ the result of the delete operation
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L322) [medusa/src/services/gift-card.ts:295](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L295)
___ ___
@@ -282,7 +300,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L114) [medusa/src/services/gift-card.ts:98](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L98)
___ ___
@@ -305,7 +323,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L85) [medusa/src/services/gift-card.ts:74](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L74)
___ ___
@@ -330,7 +348,7 @@ the gift card
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L242) [medusa/src/services/gift-card.ts:215](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L215)
___ ___
@@ -351,7 +369,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L256) [medusa/src/services/gift-card.ts:229](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L229)
___ ___
@@ -372,7 +390,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L208) [medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L182)
___ ___
@@ -396,7 +414,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -421,7 +439,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L276) [medusa/src/services/gift-card.ts:249](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L249)
___ ___
@@ -445,7 +463,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -463,7 +481,7 @@ the generated gift card code
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L69) [medusa/src/services/gift-card.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L58)
___ ___
@@ -489,4 +507,4 @@ the tax rate for the gift card
#### Defined in #### Defined in
[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/gift-card.ts#L189) [medusa/src/services/gift-card.ts:161](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/gift-card.ts#L161)
docs/content/references/services/classes/IdempotencyKeyService.md
+40 -32
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L25) [medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L25)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### idempotencyKeyRepository\_ ### idempotencyKeyRepository\_
• `Protected` `Readonly` **idempotencyKeyRepository\_**: typeof `IdempotencyKeyRepository` • `Protected` `Readonly` **idempotencyKeyRepository\_**: `Repository`<`IdempotencyKey`\>
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L23) [medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L23)
___ ___
@@ -84,13 +84,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -98,13 +98,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L21) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -143,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -169,7 +187,7 @@ the created idempotency key
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L67) [medusa/src/services/idempotency-key.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L68)
___ ___
@@ -196,7 +214,7 @@ the existing or created idempotency key
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L41) [medusa/src/services/idempotency-key.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L40)
___ ___
@@ -220,13 +238,13 @@ result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:116](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L116) [medusa/src/services/idempotency-key.ts:138](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L138)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`idempotencyKey`): `Promise`<`IdempotencyKey`\> ▸ **retrieve**(`idempotencyKeyOrSelector`): `Promise`<`IdempotencyKey`\>
Retrieves an idempotency key Retrieves an idempotency key
@@ -234,7 +252,7 @@ Retrieves an idempotency key
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `idempotencyKey` | `string` | key to retrieve | | `idempotencyKeyOrSelector` | `string` \| `Selector`<`IdempotencyKey`\> | key or selector to retrieve |
#### Returns #### Returns
@@ -244,7 +262,7 @@ idempotency key
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:85](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L85) [medusa/src/services/idempotency-key.ts:86](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L86)
___ ___
@@ -268,7 +286,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -283,17 +301,7 @@ Locks an idempotency.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `idempotencyKey` | `string` | key to update | | `idempotencyKey` | `string` | key to update |
| `update` | `Object` | update object | | `update` | `DeepPartial`<`IdempotencyKey`\> | update object |
| `update.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `update.id?` | `string` | - |
| `update.idempotency_key?` | `string` | - |
| `update.locked_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `update.recovery_point?` | `string` | - |
| `update.request_method?` | `string` | - |
| `update.request_params?` | { [x: string]: unknown; } | - |
| `update.request_path?` | `string` | - |
| `update.response_body?` | { [x: string]: unknown; } | - |
| `update.response_code?` | `number` | - |
#### Returns #### Returns
@@ -303,7 +311,7 @@ result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:145](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L145) [medusa/src/services/idempotency-key.ts:167](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L167)
___ ___
@@ -327,7 +335,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -356,4 +364,4 @@ new updated idempotency key
#### Defined in #### Defined in
[packages/medusa/src/services/idempotency-key.ts:174](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/idempotency-key.ts#L174) [medusa/src/services/idempotency-key.ts:196](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/idempotency-key.ts#L196)
docs/content/references/services/classes/LineItemAdjustmentService.md
+41 -23
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L39) [medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L36)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,31 +78,31 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L37) [medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L34)
___ ___
### lineItemAdjustmentRepo\_ ### lineItemAdjustmentRepo\_
• `Private` `Readonly` **lineItemAdjustmentRepo\_**: typeof `LineItemAdjustmentRepository` • `Private` `Readonly` **lineItemAdjustmentRepo\_**: `Repository`<`LineItemAdjustment`\>
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L36) [medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L33)
___ ___
### manager\_ ### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L33) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,13 +110,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L34) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -155,7 +173,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -179,7 +197,7 @@ line item adjustment
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:90](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L90) [medusa/src/services/line-item-adjustment.ts:86](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L86)
___ ___
@@ -204,7 +222,7 @@ a line item adjustment or undefined if no adjustment was created
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:263](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L263) [medusa/src/services/line-item-adjustment.ts:262](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L262)
___ ___
@@ -230,7 +248,7 @@ otherwise returns an array of line item adjustments for each line item in the ca
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:291](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L291) [medusa/src/services/line-item-adjustment.ts:290](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L290)
___ ___
@@ -254,7 +272,7 @@ the result of the delete operation
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:155](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L155) [medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L153)
___ ___
@@ -280,7 +298,7 @@ a line item adjustment or undefined if no adjustment was created
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:189](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L189) [medusa/src/services/line-item-adjustment.ts:188](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L188)
___ ___
@@ -305,7 +323,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:138](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L138) [medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L136)
___ ___
@@ -330,7 +348,7 @@ the line item adjustment.
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:58](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L58) [medusa/src/services/line-item-adjustment.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L53)
___ ___
@@ -354,7 +372,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -379,7 +397,7 @@ line item adjustment
#### Defined in #### Defined in
[packages/medusa/src/services/line-item-adjustment.ts:107](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item-adjustment.ts#L107) [medusa/src/services/line-item-adjustment.ts:104](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item-adjustment.ts#L104)
___ ___
@@ -403,4 +421,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/LineItemService.md
+60 -92
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L59) [medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L56)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### cartRepository\_ ### cartRepository\_
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository` • `Protected` `Readonly` **cartRepository\_**: `Repository`<`Cart`\>
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L50) [medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L47)
___ ___
@@ -86,17 +86,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L55) [medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L52)
___ ___
### itemTaxLineRepo\_ ### itemTaxLineRepo\_
• `Protected` `Readonly` **itemTaxLineRepo\_**: typeof `LineItemTaxLineRepository` • `Protected` `Readonly` **itemTaxLineRepo\_**: `Repository`<`LineItemTaxLine`\> & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: `LineItemTaxLine`[]) => `Promise`<`LineItemTaxLine`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L49) [medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L46)
___ ___
@@ -106,17 +106,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L56) [medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L53)
___ ___
### lineItemRepository\_ ### lineItemRepository\_
• `Protected` `Readonly` **lineItemRepository\_**: typeof `LineItemRepository` • `Protected` `Readonly` **lineItemRepository\_**: `Repository`<`LineItem`\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<`LineItem` & { `return_item`: `ReturnItem` }[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L48) [medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L45)
___ ___
@@ -124,13 +124,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L45) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L53) [medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L50)
___ ___
@@ -150,7 +150,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L52) [medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L49)
___ ___
@@ -160,7 +160,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L51) [medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L48)
___ ___
@@ -170,7 +170,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L54) [medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L51)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L57) [medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L54)
___ ___
@@ -188,13 +188,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L46) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -233,7 +251,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -246,48 +264,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `ids` | `string` \| `string`[] | | `ids` | `string` \| `string`[] |
| `data` | `Object` | | `data` | `DeepPartial`<`LineItem`\> |
| `data.adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; }...)[] |
| `data.allow_discounts?` | `boolean` |
| `data.cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: ... |
| `data.cart_id?` | `string` |
| `data.claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } |
| `data.claim_order_id?` | `string` |
| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.description?` | ``null`` \| `string` |
| `data.discount_total?` | ``null`` \| `number` |
| `data.fulfilled_quantity?` | ``null`` \| `number` |
| `data.gift_card_total?` | ``null`` \| `number` |
| `data.has_shipping?` | ``null`` \| `boolean` |
| `data.id?` | `string` |
| `data.includes_tax?` | `boolean` |
| `data.is_giftcard?` | `boolean` |
| `data.is_return?` | `boolean` |
| `data.metadata?` | { [x: string]: unknown; } |
| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 50 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_edit_id?` | ``null`` \| `string` |
| `data.order_id?` | ``null`` \| `string` |
| `data.original_item_id?` | ``null`` \| `string` |
| `data.original_tax_total?` | ``null`` \| `number` |
| `data.original_total?` | ``null`` \| `number` |
| `data.quantity?` | `number` |
| `data.refundable?` | ``null`` \| `number` |
| `data.returned_quantity?` | ``null`` \| `number` |
| `data.shipped_quantity?` | ``null`` \| `number` |
| `data.should_merge?` | `boolean` |
| `data.subtotal?` | ``null`` \| `number` |
| `data.swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.swap_id?` | `string` |
| `data.tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] |
| `data.tax_total?` | ``null`` \| `number` |
| `data.thumbnail?` | ``null`` \| `string` |
| `data.title?` | `string` |
| `data.total?` | ``null`` \| `number` |
| `data.unit_price?` | `number` |
| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 30 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 23 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.variant_id?` | ``null`` \| `string` |
| `options` | `Object` | | `options` | `Object` |
| `options.setOriginalLineItemId?` | `boolean` | | `options.setOriginalLineItemId?` | `boolean` |
@@ -297,7 +274,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:496](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L496) [medusa/src/services/line-item.ts:494](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L494)
___ ___
@@ -328,7 +305,7 @@ the created line item
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:377](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L377) [medusa/src/services/line-item.ts:373](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L373)
___ ___
@@ -354,7 +331,7 @@ the created line items
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:135](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L135) [medusa/src/services/line-item.ts:130](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L130)
___ ___
@@ -368,16 +345,7 @@ Create a line item tax line.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `args` | `Object` | tax line partial passed to the repo create method | | `args` | `DeepPartial`<`LineItemTaxLine`\> | tax line partial passed to the repo create method |
| `args.code?` | ``null`` \| `string` | - |
| `args.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `args.id?` | `string` | - |
| `args.item?` | { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {... | - |
| `args.item_id?` | `string` | - |
| `args.metadata?` | { [x: string]: unknown; } | - |
| `args.name?` | `string` | - |
| `args.rate?` | `number` | - |
| `args.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
#### Returns #### Returns
@@ -387,13 +355,13 @@ a new line item tax line
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:488](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L488) [medusa/src/services/line-item.ts:486](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L486)
___ ___
### delete ### delete
▸ **delete**(`id`): `Promise`<`undefined` \| `LineItem`\> ▸ **delete**(`id`): `Promise`<`undefined` \| ``null`` \| `LineItem`\>
Deletes a line item. Deletes a line item.
@@ -405,19 +373,19 @@ Deletes a line item.
#### Returns #### Returns
`Promise`<`undefined` \| `LineItem`\> `Promise`<`undefined` \| ``null`` \| `LineItem`\>
the result of the delete operation the result of the delete operation
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:448](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L448) [medusa/src/services/line-item.ts:446](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L446)
___ ___
### deleteWithTaxLines ### deleteWithTaxLines
▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| `LineItem`\> ▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| `LineItem`\>
Deletes a line item with the tax lines. Deletes a line item with the tax lines.
@@ -429,13 +397,13 @@ Deletes a line item with the tax lines.
#### Returns #### Returns
`Promise`<`undefined` \| `LineItem`\> `Promise`<`undefined` \| ``null`` \| `LineItem`\>
the result of the delete operation the result of the delete operation
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:467](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L467) [medusa/src/services/line-item.ts:465](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L465)
___ ___
@@ -467,7 +435,7 @@ Generate a single or multiple line item without persisting the data into the db
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:196](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L196) [medusa/src/services/line-item.ts:191](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L191)
___ ___
@@ -497,7 +465,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:311](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L311) [medusa/src/services/line-item.ts:306](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L306)
___ ___
@@ -518,7 +486,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:88](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L88) [medusa/src/services/line-item.ts:83](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L83)
___ ___
@@ -543,7 +511,7 @@ the line item
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:108](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L108) [medusa/src/services/line-item.ts:104](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L104)
___ ___
@@ -567,7 +535,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -592,7 +560,7 @@ the updated line item(s)
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:405](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L405) [medusa/src/services/line-item.ts:403](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L403)
___ ___
@@ -621,7 +589,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/line-item.ts:567](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/line-item.ts#L567) [medusa/src/services/line-item.ts:565](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/line-item.ts#L565)
___ ___
@@ -645,4 +613,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/MiddlewareService.md
+14 -14
View File
@@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L22) [medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L22)
## Properties ## Properties
@@ -20,7 +20,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L17) [medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L17)
___ ___
@@ -30,7 +30,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L18) [medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L18)
___ ___
@@ -40,7 +40,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L19) [medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L19)
___ ___
@@ -50,7 +50,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L20) [medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L20)
## Methods ## Methods
@@ -75,7 +75,7 @@ void
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L60) [medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L60)
___ ___
@@ -100,7 +100,7 @@ void
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L79) [medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L79)
___ ___
@@ -122,7 +122,7 @@ Adds a middleware function to be called before cart creation
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L96) [medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L96)
___ ___
@@ -143,7 +143,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L29) [medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L29)
___ ___
@@ -163,7 +163,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L34) [medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L34)
___ ___
@@ -185,7 +185,7 @@ Adds post authentication middleware to an express app.
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L106) [medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L106)
___ ___
@@ -207,7 +207,7 @@ Adds pre authentication middleware to an express app.
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L117) [medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L117)
___ ___
@@ -221,7 +221,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L123) [medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L123)
___ ___
@@ -245,4 +245,4 @@ nothing if the middleware is a function
#### Defined in #### Defined in
[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/middleware.ts#L43) [medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/middleware.ts#L43)
docs/content/references/services/classes/NewTotalsService.md
+44 -26
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:68](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L68) [medusa/src/services/new-totals.ts:67](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L67)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,21 +76,21 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L65) [medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L64)
___ ___
### manager\_ ### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:61](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L61) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:66](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L66) [medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L65)
___ ___
@@ -110,21 +110,39 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L64) [medusa/src/services/new-totals.ts:63](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L63)
___ ___
### transactionManager\_ ### transactionManager\_
• `Protected` `Readonly` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L62) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -163,7 +181,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -189,7 +207,7 @@ Calculate and return the gift cards totals
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:445](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L445) [medusa/src/services/new-totals.ts:447](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L447)
___ ___
@@ -220,7 +238,7 @@ Calculate and return the gift cards totals based on their transactions
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:524](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L524) [medusa/src/services/new-totals.ts:526](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L526)
___ ___
@@ -250,7 +268,7 @@ Return the amount that can be refund on a line item
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:331](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L331) [medusa/src/services/new-totals.ts:333](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L333)
___ ___
@@ -277,7 +295,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:401](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L401) [medusa/src/services/new-totals.ts:403](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L403)
___ ___
@@ -303,7 +321,7 @@ Calculate and return the items totals for either the legacy calculation or the n
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:90](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L90) [medusa/src/services/new-totals.ts:87](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L87)
___ ___
@@ -331,7 +349,7 @@ Calculate and return the legacy calculated totals using the tax rate
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:255](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L255) [medusa/src/services/new-totals.ts:254](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L254)
___ ___
@@ -360,7 +378,7 @@ Calculate and return the totals for an item
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:151](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L151) [medusa/src/services/new-totals.ts:147](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L147)
___ ___
@@ -387,7 +405,7 @@ Calculate and return the shipping methods totals for either the legacy calculati
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:570](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L570) [medusa/src/services/new-totals.ts:572](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L572)
___ ___
@@ -413,7 +431,7 @@ Calculate and return the shipping method totals legacy using teh tax rate
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:728](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L728) [medusa/src/services/new-totals.ts:729](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L729)
___ ___
@@ -440,7 +458,7 @@ Calculate and return the shipping method totals
#### Defined in #### Defined in
[packages/medusa/src/services/new-totals.ts:645](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/new-totals.ts#L645) [medusa/src/services/new-totals.ts:646](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/new-totals.ts#L646)
___ ___
@@ -464,7 +482,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -488,4 +506,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/NoteService.md
+38 -20
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L29) [medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L27)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L27) [medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L25)
___ ___
@@ -84,23 +84,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L24) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### noteRepository\_ ### noteRepository\_
• `Protected` `Readonly` **noteRepository\_**: typeof `NoteRepository` • `Protected` `Readonly` **noteRepository\_**: `Repository`<`Note`\>
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L26) [medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L24)
___ ___
@@ -108,13 +108,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L25) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -132,7 +132,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L18) [medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L18)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -171,7 +189,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -197,7 +215,7 @@ resolves to the creation result
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:103](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L103) [medusa/src/services/note.ts:97](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L97)
___ ___
@@ -219,7 +237,7 @@ Deletes a given note
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:161](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L161) [medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L155)
___ ___
@@ -244,7 +262,7 @@ notes related to the given search.
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:82](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L82) [medusa/src/services/note.ts:76](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L76)
___ ___
@@ -269,7 +287,7 @@ which resolves to the requested note.
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L47) [medusa/src/services/note.ts:41](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L41)
___ ___
@@ -293,7 +311,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -318,7 +336,7 @@ resolves to the updated element
#### Defined in #### Defined in
[packages/medusa/src/services/note.ts:139](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/note.ts#L139) [medusa/src/services/note.ts:133](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/note.ts#L133)
___ ___
@@ -342,4 +360,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/NotificationService.md
+46 -28
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L36) [medusa/src/services/notification.ts:33](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L33)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L27) [medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L24)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L28) [medusa/src/services/notification.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L25)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L31) [medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L28)
___ ___
@@ -104,33 +104,33 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L23) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### notificationProviderRepository\_ ### notificationProviderRepository\_
• `Protected` `Readonly` **notificationProviderRepository\_**: typeof `NotificationProviderRepository` • `Protected` `Readonly` **notificationProviderRepository\_**: `Repository`<`NotificationProvider`\>
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L34) [medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L31)
___ ___
### notificationRepository\_ ### notificationRepository\_
• `Protected` `Readonly` **notificationRepository\_**: typeof `NotificationRepository` • `Protected` `Readonly` **notificationRepository\_**: `Repository`<`Notification`\>
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L32) [medusa/src/services/notification.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L29)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L26) [medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L23)
___ ___
@@ -148,13 +148,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L24) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -193,7 +211,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -220,7 +238,7 @@ the result of notification subscribed
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L174) [medusa/src/services/notification.ts:165](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L165)
___ ___
@@ -245,7 +263,7 @@ the notifications that satisfy the query.
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L86) [medusa/src/services/notification.ts:77](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L77)
___ ___
@@ -268,7 +286,7 @@ used to generate on demand invoices or other documents.
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L62) [medusa/src/services/notification.ts:51](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L51)
___ ___
@@ -290,7 +308,7 @@ Takes a list of notification provider ids and persists them in the database.
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L70) [medusa/src/services/notification.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L59)
___ ___
@@ -316,7 +334,7 @@ the newly created notification
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L254) [medusa/src/services/notification.ts:245](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L245)
___ ___
@@ -341,7 +359,7 @@ the notification
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L107) [medusa/src/services/notification.ts:98](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L98)
___ ___
@@ -366,7 +384,7 @@ the notification provider
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L155) [medusa/src/services/notification.ts:146](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L146)
___ ___
@@ -393,7 +411,7 @@ the created notification
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L206) [medusa/src/services/notification.ts:197](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L197)
___ ___
@@ -417,7 +435,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -440,7 +458,7 @@ Subscribes a given provider to an event.
#### Defined in #### Defined in
[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/notification.ts#L134) [medusa/src/services/notification.ts:125](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/notification.ts#L125)
___ ___
@@ -464,4 +482,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/OauthService.md
+42 -34
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L31) [medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L28)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L27) [medusa/src/services/oauth.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L24)
___ ___
@@ -86,17 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L29) [medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L26)
___
### manager
• `Protected` **manager**: `EntityManager`
#### Defined in
[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L26)
___ ___
@@ -104,23 +94,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L19) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### oauthRepository\_ ### oauthRepository\_
• `Protected` **oauthRepository\_**: typeof `OauthRepository` • `Protected` **oauthRepository\_**: `Repository`<`Oauth`\>
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L28) [medusa/src/services/oauth.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L25)
___ ___
@@ -128,13 +118,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -151,7 +141,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L21) [medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L19)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -190,7 +198,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -210,7 +218,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:88](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L88) [medusa/src/services/oauth.ts:87](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L87)
___ ___
@@ -232,7 +240,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:122](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L122) [medusa/src/services/oauth.ts:121](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L121)
___ ___
@@ -252,7 +260,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:80](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L80) [medusa/src/services/oauth.ts:79](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L79)
___ ___
@@ -272,7 +280,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:156](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L156) [medusa/src/services/oauth.ts:155](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L155)
___ ___
@@ -292,7 +300,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:112](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L112) [medusa/src/services/oauth.ts:111](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L111)
___ ___
@@ -312,7 +320,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L57) [medusa/src/services/oauth.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L54)
___ ___
@@ -332,7 +340,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L41) [medusa/src/services/oauth.ts:36](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L36)
___ ___
@@ -356,7 +364,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -377,7 +385,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/oauth.ts:101](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/oauth.ts#L101) [medusa/src/services/oauth.ts:100](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/oauth.ts#L100)
___ ___
@@ -401,4 +409,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/OrderEditItemChangeService.md
+40 -22
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L34) [medusa/src/services/order-edit-item-change.ts:33](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L33)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### eventBus\_ ### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md) • `Protected` `Readonly` **eventBus\_**: `IEventBusService`
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L30) [medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L29)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L31) [medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L30)
___ ___
@@ -94,23 +94,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L26) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### orderItemChangeRepository\_ ### orderItemChangeRepository\_
• `Protected` `Readonly` **orderItemChangeRepository\_**: typeof `OrderItemChangeRepository` • `Protected` `Readonly` **orderItemChangeRepository\_**: `Repository`<`OrderItemChange`\>
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L29) [medusa/src/services/order-edit-item-change.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L28)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L32) [medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L31)
___ ___
@@ -128,13 +128,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L27) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -151,7 +151,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L21) [medusa/src/services/order-edit-item-change.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L22)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -190,7 +208,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -210,7 +228,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L86) [medusa/src/services/order-edit-item-change.ts:81](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L81)
___ ___
@@ -230,7 +248,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L102) [medusa/src/services/order-edit-item-change.ts:97](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L97)
___ ___
@@ -251,7 +269,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L73) [medusa/src/services/order-edit-item-change.ts:69](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L69)
___ ___
@@ -272,7 +290,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit-item-change.ts#L51) [medusa/src/services/order-edit-item-change.ts:48](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit-item-change.ts#L48)
___ ___
@@ -296,7 +314,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -320,4 +338,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/OrderEditService.md
+73 -75
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L68) [medusa/src/services/order-edit.ts:75](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L75)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L63) [medusa/src/services/order-edit.ts:69](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L69)
___
### inventoryService\_
• `Protected` `Readonly` **inventoryService\_**: `undefined` \| `IInventoryService`
#### Defined in
[medusa/src/services/order-edit.ts:73](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L73)
___ ___
@@ -86,7 +96,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L65) [medusa/src/services/order-edit.ts:71](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L71)
___ ___
@@ -96,21 +106,21 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L62) [medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L68)
___ ___
### manager\_ ### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L54) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -120,7 +130,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L61) [medusa/src/services/order-edit.ts:67](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L67)
___ ___
@@ -130,17 +140,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L66) [medusa/src/services/order-edit.ts:72](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L72)
___ ___
### orderEditRepository\_ ### orderEditRepository\_
• `Protected` `Readonly` **orderEditRepository\_**: typeof `OrderEditRepository` • `Protected` `Readonly` **orderEditRepository\_**: `Repository`<`OrderEdit`\>
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L57) [medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L63)
___ ___
@@ -150,7 +160,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L59) [medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L65)
___ ___
@@ -160,7 +170,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L64) [medusa/src/services/order-edit.ts:70](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L70)
___ ___
@@ -170,7 +180,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L60) [medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L66)
___ ___
@@ -178,13 +188,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L55) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -205,7 +215,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L45) [medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L54)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -226,7 +254,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:534](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L534) [medusa/src/services/order-edit.ts:540](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L540)
___ ___
@@ -265,7 +293,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -287,7 +315,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:678](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L678) [medusa/src/services/order-edit.ts:686](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L686)
___ ___
@@ -309,7 +337,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:717](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L717) [medusa/src/services/order-edit.ts:725](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L725)
___ ___
@@ -331,7 +359,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:156](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L156) [medusa/src/services/order-edit.ts:162](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L162)
___ ___
@@ -354,7 +382,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:258](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L258) [medusa/src/services/order-edit.ts:260](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L260)
___ ___
@@ -374,7 +402,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:491](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L491) [medusa/src/services/order-edit.ts:490](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L490)
___ ___
@@ -394,7 +422,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:234](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L234) [medusa/src/services/order-edit.ts:238](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L238)
___ ___
@@ -414,7 +442,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:790](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L790) [medusa/src/services/order-edit.ts:808](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L808)
___ ___
@@ -435,7 +463,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:606](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L606) [medusa/src/services/order-edit.ts:612](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L612)
___ ___
@@ -456,7 +484,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:148](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L148) [medusa/src/services/order-edit.ts:154](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L154)
___ ___
@@ -477,7 +505,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:124](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L124) [medusa/src/services/order-edit.ts:130](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L130)
___ ___
@@ -499,7 +527,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L439) [medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L439)
___ ___
@@ -520,7 +548,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L382) [medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L382)
___ ___
@@ -542,7 +570,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:638](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L638) [medusa/src/services/order-edit.ts:644](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L644)
___ ___
@@ -563,13 +591,13 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:95](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L95) [medusa/src/services/order-edit.ts:102](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L102)
___ ___
### retrieveActive ### retrieveActive
▸ `Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| `OrderEdit`\> ▸ `Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| ``null`` \| `OrderEdit`\>
#### Parameters #### Parameters
@@ -580,11 +608,11 @@ ___
#### Returns #### Returns
`Promise`<`undefined` \| `OrderEdit`\> `Promise`<`undefined` \| ``null`` \| `OrderEdit`\>
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:769](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L769) [medusa/src/services/order-edit.ts:788](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L788)
___ ___
@@ -608,7 +636,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -621,37 +649,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `orderEditId` | `string` | | `orderEditId` | `string` |
| `data` | `Object` | | `data` | `DeepPartial`<`OrderEdit`\> |
| `data.canceled_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.canceled_by?` | `string` |
| `data.changes?` | (`undefined` \| { type?: OrderEditItemChangeType \| undefined; order\_edit\_id?: string \| undefined; order\_edit?: { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; ... 52 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 7 ...)[] |
| `data.confirmed_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.confirmed_by?` | `string` |
| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.created_by?` | `string` |
| `data.declined_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.declined_by?` | `string` |
| `data.declined_reason?` | `string` |
| `data.difference_due?` | `number` |
| `data.discount_total?` | `number` |
| `data.gift_card_tax_total?` | `number` |
| `data.gift_card_total?` | `number` |
| `data.id?` | `string` |
| `data.internal_note?` | `string` |
| `data.items?` | (`undefined` \| { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {...)[] |
| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.order_id?` | `string` |
| `data.payment_collection?` | { type?: PaymentCollectionType \| undefined; status?: PaymentCollectionStatus \| undefined; description?: string \| null \| undefined; ... 13 more ...; updated\_at?: { ...; } \| undefined; } |
| `data.payment_collection_id?` | `string` |
| `data.requested_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.requested_by?` | `string` |
| `data.shipping_total?` | `number` |
| `data.status?` | `OrderEditStatus` |
| `data.subtotal?` | `number` |
| `data.tax_total?` | ``null`` \| `number` |
| `data.total?` | `number` |
| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `data.loadStatus?` | |
#### Returns #### Returns
@@ -659,7 +657,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:205](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L205) [medusa/src/services/order-edit.ts:211](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L211)
___ ___
@@ -686,7 +684,7 @@ Create or update order edit item change line item and apply the quantity
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L309) [medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L309)
___ ___
@@ -710,7 +708,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -730,4 +728,4 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order-edit.ts:836](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order-edit.ts#L836) [medusa/src/services/order-edit.ts:860](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order-edit.ts#L860)
docs/content/references/services/classes/OrderService.md
+92 -64
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L125) [medusa/src/services/order.ts:137](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L137)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) utils/dist/common/transaction-base-service.d.ts:5
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) utils/dist/common/transaction-base-service.d.ts:4
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) utils/dist/common/transaction-base-service.d.ts:6
___ ___
### addressRepository\_ ### addressRepository\_
• `Protected` `Readonly` **addressRepository\_**: typeof `AddressRepository` • `Protected` `Readonly` **addressRepository\_**: `Repository`<`Address`\>
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L117) [medusa/src/services/order.ts:128](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L128)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L116) [medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L127)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L104) [medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L115)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L108) [medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L119)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L119) [medusa/src/services/order.ts:130](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L130)
___ ___
@@ -126,7 +126,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L120) [medusa/src/services/order.ts:132](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L132)
___ ___
@@ -136,7 +136,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L121) [medusa/src/services/order.ts:133](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L133)
___ ___
@@ -146,7 +146,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L109) [medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L120)
___ ___
@@ -156,7 +156,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:110](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L110) [medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L121)
___ ___
@@ -166,7 +166,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L118) [medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L129)
___
### inventoryService\_
• `Protected` `Readonly` **inventoryService\_**: `IInventoryService`
#### Defined in
[medusa/src/services/order.ts:131](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L131)
___ ___
@@ -176,7 +186,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L111) [medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L122)
___ ___
@@ -184,13 +194,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L100) utils/dist/common/transaction-base-service.d.ts:7
___ ___
@@ -200,17 +210,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:113](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L113) [medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L124)
___ ___
### orderRepository\_ ### orderRepository\_
• `Protected` `Readonly` **orderRepository\_**: typeof `OrderRepository` • `Protected` `Readonly` **orderRepository\_**: `Repository`<`Order`\> & { `findOneWithRelations`: (`relations`: `FindOptionsRelations`<`Order`\>, `optionsWithoutRelations`: `Omit`<`FindManyOptions`<`Order`\>, ``"relations"``\>) => `Promise`<`Order`\> ; `findWithRelations`: (`relations`: `FindOptionsRelations`<`Order`\>, `optionsWithoutRelations`: `Omit`<`FindManyOptions`<`Order`\>, ``"relations"``\>) => `Promise`<`Order`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L103) [medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L114)
___ ___
@@ -220,7 +230,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L105) [medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L116)
___ ___
@@ -230,7 +240,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L123) [medusa/src/services/order.ts:135](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L135)
___ ___
@@ -240,7 +250,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L115) [medusa/src/services/order.ts:126](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L126)
___ ___
@@ -250,7 +260,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L106) [medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L117)
___ ___
@@ -260,7 +270,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L107) [medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L118)
___ ___
@@ -270,7 +280,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L114) [medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L125)
___ ___
@@ -280,21 +290,21 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:112](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L112) [medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L123)
___ ___
### transactionManager\_ ### transactionManager\_
• `Protected` **transactionManager\_**: `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L101) utils/dist/common/transaction-base-service.d.ts:8
___ ___
@@ -325,7 +335,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:81](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L81) [medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L95)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:9
## Methods ## Methods
@@ -348,7 +376,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:945](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L945) [medusa/src/services/order.ts:1011](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1011)
___ ___
@@ -373,7 +401,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1483](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1483) [medusa/src/services/order.ts:1547](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1547)
___ ___
@@ -412,7 +440,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) utils/dist/common/transaction-base-service.d.ts:24
___ ___
@@ -438,7 +466,7 @@ result of the update operation.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1097](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1097) [medusa/src/services/order.ts:1163](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1163)
___ ___
@@ -462,7 +490,7 @@ updated order
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1420](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1420) [medusa/src/services/order.ts:1484](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1484)
___ ___
@@ -486,7 +514,7 @@ result of the update operation.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1186](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1186) [medusa/src/services/order.ts:1252](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1252)
___ ___
@@ -508,7 +536,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:513](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L513) [medusa/src/services/order.ts:571](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L571)
___ ___
@@ -532,7 +560,7 @@ resolves to the creation result.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:543](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L543) [medusa/src/services/order.ts:601](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L601)
___ ___
@@ -564,7 +592,7 @@ result of the update operation.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1291](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1291) [medusa/src/services/order.ts:1357](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1357)
___ ___
@@ -586,7 +614,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:733](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L733) [medusa/src/services/order.ts:791](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L791)
___ ___
@@ -615,7 +643,7 @@ the result of the refund operation.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1509](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1509) [medusa/src/services/order.ts:1573](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1573)
___ ___
@@ -646,7 +674,7 @@ the resulting order following the update.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:787](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L787) [medusa/src/services/order.ts:845](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L845)
___ ___
@@ -669,7 +697,7 @@ Calculate and attach the different total fields on the object
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1706](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1706) [medusa/src/services/order.ts:1770](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1770)
▸ **decorateTotals**(`order`, `context?`): `Promise`<`Order`\> ▸ **decorateTotals**(`order`, `context?`): `Promise`<`Order`\>
@@ -688,7 +716,7 @@ Calculate and attach the different total fields on the object
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1708](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1708) [medusa/src/services/order.ts:1772](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1772)
___ ___
@@ -709,7 +737,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1577](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1577) [medusa/src/services/order.ts:1641](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1641)
___ ___
@@ -735,7 +763,7 @@ the line items generated by the transformer.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1462](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1462) [medusa/src/services/order.ts:1526](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1526)
___ ___
@@ -755,7 +783,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1966](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1966) [medusa/src/services/order.ts:2035](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L2035)
___ ___
@@ -778,7 +806,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:179](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L179) [medusa/src/services/order.ts:189](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L189)
___ ___
@@ -801,7 +829,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:196](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L196) [medusa/src/services/order.ts:206](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L206)
___ ___
@@ -833,7 +861,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1891](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1891) [medusa/src/services/order.ts:1960](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1960)
___ ___
@@ -858,7 +886,7 @@ the order document
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:339](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L339) [medusa/src/services/order.ts:390](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L390)
___ ___
@@ -883,7 +911,7 @@ the order document
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:435](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L435) [medusa/src/services/order.ts:486](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L486)
___ ___
@@ -908,7 +936,7 @@ the order document
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:476](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L476) [medusa/src/services/order.ts:527](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L527)
___ ___
@@ -929,7 +957,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:380](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L380) [medusa/src/services/order.ts:430](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L430)
___ ___
@@ -951,7 +979,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:418](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L418) [medusa/src/services/order.ts:469](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L469)
___ ___
@@ -975,7 +1003,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) utils/dist/common/transaction-base-service.d.ts:12
___ ___
@@ -1001,7 +1029,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:263](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L263) [medusa/src/services/order.ts:312](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L312)
___ ___
@@ -1028,7 +1056,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1008](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1008) [medusa/src/services/order.ts:1074](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1074)
___ ___
@@ -1053,7 +1081,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:875](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L875) [medusa/src/services/order.ts:933](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L933)
___ ___
@@ -1078,7 +1106,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:914](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L914) [medusa/src/services/order.ts:980](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L980)
___ ___
@@ -1107,7 +1135,7 @@ a line item that has the requested fulfillment quantity
#### Defined in #### Defined in
[packages/medusa/src/services/order.ts:1258](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/order.ts#L1258) [medusa/src/services/order.ts:1324](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/order.ts#L1324)
___ ___
@@ -1131,4 +1159,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) utils/dist/common/transaction-base-service.d.ts:11
docs/content/references/services/classes/PaymentCollectionService.md
+47 -46
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L51) [medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L46)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L47) [medusa/src/services/payment-collection.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L42)
___ ___
@@ -86,31 +86,31 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L45) [medusa/src/services/payment-collection.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L40)
___ ___
### manager\_ ### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L43) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### paymentCollectionRepository\_ ### paymentCollectionRepository\_
• `Protected` `Readonly` **paymentCollectionRepository\_**: typeof `PaymentCollectionRepository` • `Protected` `Readonly` **paymentCollectionRepository\_**: `Repository`<`PaymentCollection`\> & { `getPaymentCollectionIdByPaymentId`: (`paymentId`: `string`, `config`: `FindConfig`<`PaymentCollection`\>) => `Promise`<`PaymentCollection`\> ; `getPaymentCollectionIdBySessionId`: (`sessionId`: `string`, `config`: `FindConfig`<`PaymentCollection`\>) => `Promise`<`PaymentCollection`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L49) [medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L44)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L46) [medusa/src/services/payment-collection.ts:41](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L41)
___ ___
@@ -128,13 +128,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L44) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -153,7 +153,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:36](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L36) [medusa/src/services/payment-collection.ts:33](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L33)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -192,7 +210,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -218,7 +236,7 @@ the payment collection and its payment session.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:535](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L535) [medusa/src/services/payment-collection.ts:527](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L527)
___ ___
@@ -242,7 +260,7 @@ the payment collection created.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:111](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L111) [medusa/src/services/payment-collection.ts:103](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L103)
___ ___
@@ -266,7 +284,7 @@ the payment collection removed.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:180](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L180) [medusa/src/services/payment-collection.ts:172](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L172)
___ ___
@@ -287,7 +305,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:218](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L218) [medusa/src/services/payment-collection.ts:210](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L210)
___ ___
@@ -311,7 +329,7 @@ the payment session authorized.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:506](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L506) [medusa/src/services/payment-collection.ts:498](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L498)
___ ___
@@ -337,7 +355,7 @@ the new payment session created.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:414](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L414) [medusa/src/services/payment-collection.ts:406](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L406)
___ ___
@@ -362,7 +380,7 @@ the payment collection.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L74) [medusa/src/services/payment-collection.ts:67](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L67)
___ ___
@@ -388,7 +406,7 @@ the payment collection and its payment session.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:368](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L368) [medusa/src/services/payment-collection.ts:360](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L360)
___ ___
@@ -414,7 +432,7 @@ the payment collection and its payment sessions.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:233](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L233) [medusa/src/services/payment-collection.ts:225](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L225)
___ ___
@@ -438,7 +456,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -453,24 +471,7 @@ Updates a payment collection.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `paymentCollectionId` | `string` | the id of the payment collection to update | | `paymentCollectionId` | `string` | the id of the payment collection to update |
| `data` | `Object` | info to be updated | | `data` | `DeepPartial`<`PaymentCollection`\> | 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 #### Returns
@@ -480,7 +481,7 @@ the payment collection updated.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-collection.ts:146](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-collection.ts#L146) [medusa/src/services/payment-collection.ts:138](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-collection.ts#L138)
___ ___
@@ -504,4 +505,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/PaymentProviderService.md
+133 -65
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L64) [medusa/src/services/payment-provider.ts:70](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L70)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L53) [medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L55)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L59) [medusa/src/services/payment-provider.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L65)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L62) [medusa/src/services/payment-provider.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L68)
___ ___
@@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L60) [medusa/src/services/payment-provider.ts:66](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L66)
___ ___
@@ -116,53 +116,53 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L51) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### paymentProviderRepository\_ ### paymentProviderRepository\_
• `Protected` `Readonly` **paymentProviderRepository\_**: typeof `PaymentProviderRepository` • `Protected` `Readonly` **paymentProviderRepository\_**: `Repository`<`PaymentProvider`\>
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L56) [medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L58)
___ ___
### paymentRepository\_ ### paymentRepository\_
• `Protected` `Readonly` **paymentRepository\_**: typeof `PaymentRepository` • `Protected` `Readonly` **paymentRepository\_**: `Repository`<`Payment`\>
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L57) [medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L59)
___ ___
### paymentSessionRepository\_ ### paymentSessionRepository\_
• `Protected` `Readonly` **paymentSessionRepository\_**: typeof `PaymentSessionRepository` • `Protected` `Readonly` **paymentSessionRepository\_**: `Repository`<`PaymentSession`\>
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L54) [medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L56)
___ ___
### refundRepository\_ ### refundRepository\_
• `Protected` `Readonly` **refundRepository\_**: typeof `RefundRepository` • `Protected` `Readonly` **refundRepository\_**: `Repository`<`Refund`\>
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L58) [medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L64)
___ ___
@@ -170,13 +170,45 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L52) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
___
### paymentService\_
• `Protected` `get` **paymentService_**(): [`PaymentService`](PaymentService.md)
#### Returns
[`PaymentService`](PaymentService.md)
#### Defined in
[medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L60)
## Methods ## Methods
@@ -215,7 +247,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -236,7 +268,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:395](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L395) [medusa/src/services/payment-provider.ts:523](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L523)
___ ___
@@ -258,7 +290,7 @@ Build the create session context for both legacy and new API
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:641](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L641) [medusa/src/services/payment-provider.ts:840](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L840)
___ ___
@@ -278,7 +310,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:448](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L448) [medusa/src/services/payment-provider.ts:597](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L597)
___ ___
@@ -298,7 +330,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:473](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L473) [medusa/src/services/payment-provider.ts:636](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L636)
___ ___
@@ -318,38 +350,48 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:357](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L357) [medusa/src/services/payment-provider.ts:471](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L471)
___ ___
### createSession ### createSession
▸ **createSession**<`TInput`\>(`providerIdOrSessionInput`, ...`cart`): `Promise`<`PaymentSession`\> ▸ **createSession**(`providerId`, `cart`): `Promise`<`PaymentSession`\>
Creates a payment session with the given provider. **`Deprecated`**
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TInput` | extends `string` \| `PaymentSessionInput` = `string` \| `PaymentSessionInput` |
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type |
| :------ | :------ | :------ | | :------ | :------ |
| `providerIdOrSessionInput` | `TInput` | the id of the provider to create payment with or the input data | | `providerId` | `string` |
| `...cart` | `TInput` extends `string` ? [`Cart`] : [undefined?] | a cart object used to calculate the amount, etc. from | | `cart` | `Cart` |
#### Returns #### Returns
`Promise`<`PaymentSession`\> `Promise`<`PaymentSession`\>
the payment session #### Defined in
[medusa/src/services/payment-provider.ts:205](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L205)
▸ **createSession**(`sessionInput`): `Promise`<`PaymentSession`\>
Creates a payment session with the given provider.
#### Parameters
| Name | Type |
| :------ | :------ |
| `sessionInput` | `PaymentSessionInput` |
#### Returns
`Promise`<`PaymentSession`\>
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:180](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L180) [medusa/src/services/payment-provider.ts:211](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L211)
___ ___
@@ -369,7 +411,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:303](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L303) [medusa/src/services/payment-provider.ts:402](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L402)
___ ___
@@ -389,7 +431,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:468](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L468) [medusa/src/services/payment-provider.ts:625](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L625)
___ ___
@@ -403,7 +445,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:97](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L97) [medusa/src/services/payment-provider.ts:102](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L102)
___ ___
@@ -411,6 +453,8 @@ ___
▸ **listPayments**(`selector`, `config?`): `Promise`<`Payment`[]\> ▸ **listPayments**(`selector`, `config?`): `Promise`<`Payment`[]\>
List all the payments according to the given selector and config.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
@@ -424,7 +468,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:132](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L132) [medusa/src/services/payment-provider.ts:154](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L154)
___ ___
@@ -449,7 +493,7 @@ Process the collected data. Can be used every time we need to process some colle
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:731](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L731) [medusa/src/services/payment-provider.ts:930](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L930)
___ ___
@@ -478,7 +522,7 @@ the payment session
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:238](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L238) [medusa/src/services/payment-provider.ts:301](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L301)
___ ___
@@ -501,7 +545,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:578](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L578) [medusa/src/services/payment-provider.ts:766](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L766)
___ ___
@@ -524,7 +568,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:493](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L493) [medusa/src/services/payment-provider.ts:667](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L667)
___ ___
@@ -544,19 +588,21 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:78](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L78) [medusa/src/services/payment-provider.ts:83](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L83)
___ ___
### retrievePayment ### retrievePayment
▸ **retrievePayment**(`id`, `relations?`): `Promise`<`Payment`\> ▸ **retrievePayment**(`paymentId`, `relations?`): `Promise`<`Payment`\>
Retrieve a payment entity with the given id.
#### Parameters #### Parameters
| Name | Type | Default value | | Name | Type | Default value |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | `undefined` | | `paymentId` | `string` | `undefined` |
| `relations` | `string`[] | `[]` | | `relations` | `string`[] | `[]` |
#### Returns #### Returns
@@ -565,13 +611,13 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:104](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L104) [medusa/src/services/payment-provider.ts:114](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L114)
___ ___
### retrieveProvider ### retrieveProvider
▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any` ▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `TProvider` extends `AbstractPaymentProcessor` ? `AbstractPaymentProcessor` : `any`
Finds a provider given an id Finds a provider given an id
@@ -589,13 +635,13 @@ Finds a provider given an id
#### Returns #### Returns
`TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any` `TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `TProvider` extends `AbstractPaymentProcessor` ? `AbstractPaymentProcessor` : `any`
the payment provider the payment provider
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:333](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L333) [medusa/src/services/payment-provider.ts:442](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L442)
___ ___
@@ -616,19 +662,21 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:618](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L618) [medusa/src/services/payment-provider.ts:817](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L817)
___ ___
### retrieveSession ### retrieveSession
▸ **retrieveSession**(`id`, `relations?`): `Promise`<`PaymentSession`\> ▸ **retrieveSession**(`paymentSessionId`, `relations?`): `Promise`<`PaymentSession`\>
Return the payment session for the given id.
#### Parameters #### Parameters
| Name | Type | Default value | | Name | Type | Default value |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | `undefined` | | `paymentSessionId` | `string` | `undefined` |
| `relations` | `string`[] | `[]` | | `relations` | `string`[] | `[]` |
#### Returns #### Returns
@@ -637,7 +685,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:145](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L145) [medusa/src/services/payment-provider.ts:172](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L172)
___ ___
@@ -667,7 +715,7 @@ Create or update a Payment session data.
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:681](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L681) [medusa/src/services/payment-provider.ts:882](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L882)
___ ___
@@ -691,7 +739,27 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### throwFromPaymentProcessorError
▸ `Private` **throwFromPaymentProcessorError**(`errObj`): `void`
#### Parameters
| Name | Type |
| :------ | :------ |
| `errObj` | `PaymentProcessorError` |
#### Returns
`void`
#### Defined in
[medusa/src/services/payment-provider.ts:949](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L949)
___ ___
@@ -714,7 +782,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:383](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L383) [medusa/src/services/payment-provider.ts:512](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L512)
___ ___
@@ -742,7 +810,7 @@ the payment session
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:268](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L268) [medusa/src/services/payment-provider.ts:342](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L342)
___ ___
@@ -763,7 +831,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment-provider.ts:427](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment-provider.ts#L427) [medusa/src/services/payment-provider.ts:569](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment-provider.ts#L569)
___ ___
@@ -787,4 +855,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/PaymentService.md
+40 -22
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L40) [medusa/src/services/payment.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L39)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,21 +76,21 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L28) [medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L27)
___ ___
### manager\_ ### manager\_
• `Protected` `Readonly` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L26) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -100,17 +100,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L29) [medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L28)
___ ___
### paymentRepository\_ ### paymentRepository\_
• `Protected` `Readonly` **paymentRepository\_**: typeof `PaymentRepository` • `Protected` `Readonly` **paymentRepository\_**: `Repository`<`Payment`\>
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L30) [medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L29)
___ ___
@@ -118,13 +118,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L27) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -145,7 +145,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L31) [medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L30)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -184,7 +202,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -208,7 +226,7 @@ the payment captured.
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:161](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L161) [medusa/src/services/payment.ts:153](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L153)
___ ___
@@ -232,7 +250,7 @@ the payment created.
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:96](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L96) [medusa/src/services/payment.ts:92](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L92)
___ ___
@@ -259,7 +277,7 @@ the refund created.
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:210](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L210) [medusa/src/services/payment.ts:202](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L202)
___ ___
@@ -284,7 +302,7 @@ the payment.
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:61](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L61) [medusa/src/services/payment.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L58)
___ ___
@@ -308,7 +326,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -335,7 +353,7 @@ the payment updated.
#### Defined in #### Defined in
[packages/medusa/src/services/payment.ts:127](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/payment.ts#L127) [medusa/src/services/payment.ts:121](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/payment.ts#L121)
___ ___
@@ -359,4 +377,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/PriceListService.md
+58 -40
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L57) [medusa/src/services/price-list.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L59)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L48) [medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L50)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L55) [medusa/src/services/price-list.ts:57](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L57)
___ ___
@@ -96,33 +96,33 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L45) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### moneyAmountRepo\_ ### moneyAmountRepo\_
• `Protected` `Readonly` **moneyAmountRepo\_**: typeof `MoneyAmountRepository` • `Protected` `Readonly` **moneyAmountRepo\_**: `Repository`<`MoneyAmount`\> & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: `PriceListPriceCreateInput`[], `overrideExisting`: `boolean`) => `Promise`<`MoneyAmount`[]\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: `ProductVariantPrice`[] ; `variantId`: `string` }[], `prices?`: `Price`[]) => `Promise`<`void`\> ; `findManyForVariantInPriceList`: (`variant_id`: `string`, `price_list_id`: `string`, `requiresPriceList`: `boolean`) => `Promise`<[`MoneyAmount`[], `number`]\> ; `findManyForVariantInRegion`: (`variant_id`: `string`, `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing`: `boolean`) => `Promise`<[`MoneyAmount`[], `number`]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: `Price`[]) => `Promise`<`MoneyAmount`[]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<`MoneyAmount`\>[]) => `Promise`<`MoneyAmount`[]\> ; `updatePriceListPrices`: (`priceListId`: `string`, `updates`: `PriceListPriceUpdateInput`[]) => `Promise`<`MoneyAmount`[]\> ; `upsertVariantCurrencyPrice`: (`variantId`: `string`, `price`: `Price`) => `Promise`<`MoneyAmount`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L53) [medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L55)
___ ___
### priceListRepo\_ ### priceListRepo\_
• `Protected` `Readonly` **priceListRepo\_**: typeof `PriceListRepository` • `Protected` `Readonly` **priceListRepo\_**: `Repository`<`PriceList`\> & { `listAndCount`: (`query`: `ExtendedFindConfig`<`PriceList`\>, `q?`: `string`) => `Promise`<[`PriceList`[], `number`]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L52) [medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L54)
___ ___
@@ -132,17 +132,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L50) [medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L52)
___ ___
### productVariantRepo\_ ### productVariantRepo\_
• `Protected` `Readonly` **productVariantRepo\_**: typeof `ProductVariantRepository` • `Protected` `Readonly` **productVariantRepo\_**: `Repository`<`ProductVariant`\>
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L54) [medusa/src/services/price-list.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L56)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L49) [medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L51)
___ ___
@@ -160,13 +160,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L46) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -176,7 +176,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L51) [medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L53)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -190,7 +208,7 @@ Add `currency_code` to an MA record if `region_id`is passed.
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | extends `PriceListPriceCreateInput` \| `PriceListPriceUpdateInput` | | `T` | extends `PriceListPriceUpdateInput` \| `PriceListPriceCreateInput` |
#### Parameters #### Parameters
@@ -206,7 +224,7 @@ updated `prices` list
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:519](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L519) [medusa/src/services/price-list.ts:563](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L563)
___ ___
@@ -232,7 +250,7 @@ updated Price List
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:218](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L218) [medusa/src/services/price-list.ts:220](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L220)
___ ___
@@ -271,7 +289,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -295,7 +313,7 @@ updated Price List
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:258](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L258) [medusa/src/services/price-list.ts:260](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L260)
___ ___
@@ -319,7 +337,7 @@ created Price List
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:119](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L119) [medusa/src/services/price-list.ts:121](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L121)
___ ___
@@ -344,7 +362,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:272](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L272) [medusa/src/services/price-list.ts:274](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L274)
___ ___
@@ -369,7 +387,7 @@ updated Price List
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:243](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L243) [medusa/src/services/price-list.ts:245](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L245)
___ ___
@@ -390,7 +408,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:446](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L446) [medusa/src/services/price-list.ts:490](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L490)
___ ___
@@ -411,7 +429,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:483](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L483) [medusa/src/services/price-list.ts:527](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L527)
___ ___
@@ -436,7 +454,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:292](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L292) [medusa/src/services/price-list.ts:294](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L294)
___ ___
@@ -451,7 +469,7 @@ Lists Price Lists and adds count
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `FilterablePriceListProps` | the query object for find | | `selector` | `FilterablePriceListProps` | the query object for find |
| `config` | `FindConfig`<`FilterablePriceListProps`\> | the config to be used for find | | `config` | `FindConfig`<`PriceList`\> | the config to be used for find |
#### Returns #### Returns
@@ -461,7 +479,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L316) [medusa/src/services/price-list.ts:324](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L324)
___ ___
@@ -474,7 +492,7 @@ ___
| Name | Type | Default value | | Name | Type | Default value |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `priceListId` | `string` | `undefined` | | `priceListId` | `string` | `undefined` |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | `{}` | | `selector` | `FilterableProductProps` \| `Selector`<`Product`\> | `{}` |
| `config` | `FindConfig`<`Product`\> | `undefined` | | `config` | `FindConfig`<`Product`\> | `undefined` |
| `requiresPriceList` | `boolean` | `false` | | `requiresPriceList` | `boolean` | `false` |
@@ -484,7 +502,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:364](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L364) [medusa/src/services/price-list.ts:408](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L408)
___ ___
@@ -507,7 +525,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:412](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L412) [medusa/src/services/price-list.ts:456](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L456)
___ ___
@@ -532,7 +550,7 @@ the collection.
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L88) [medusa/src/services/price-list.ts:88](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L88)
___ ___
@@ -556,7 +574,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -581,7 +599,7 @@ updated Price List
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:167](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L167) [medusa/src/services/price-list.ts:169](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L169)
___ ___
@@ -602,7 +620,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/price-list.ts:345](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/price-list.ts#L345) [medusa/src/services/price-list.ts:387](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/price-list.ts#L387)
___ ___
@@ -626,4 +644,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/PricingService.md
+51 -33
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L44) [medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L42)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L42) [medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L40)
___ ___
@@ -86,13 +86,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L36) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -102,7 +102,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L40) [medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L38)
___ ___
@@ -112,7 +112,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L41) [medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L39)
___ ___
@@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L38) [medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L36)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L39) [medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L37)
___ ___
@@ -140,13 +140,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -185,13 +203,13 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
### calculateTaxes ### calculateTaxes
▸ **calculateTaxes**(`variantPricing`, `productRates`): `Promise`<`TaxedPricing`\> ▸ **calculateTaxes**(`variantPricing`, `productRates`): `TaxedPricing`
Gets the prices for a product variant Gets the prices for a product variant
@@ -204,13 +222,13 @@ Gets the prices for a product variant
#### Returns #### Returns
`Promise`<`TaxedPricing`\> `TaxedPricing`
The tax related variant prices. The tax related variant prices.
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L105) [medusa/src/services/pricing.ts:101](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L101)
___ ___
@@ -218,7 +236,7 @@ ___
▸ **collectPricingContext**(`context`): `Promise`<`PricingContext`\> ▸ **collectPricingContext**(`context`): `Promise`<`PricingContext`\>
Collects additional information neccessary for completing the price Collects additional information necessary for completing the price
selection. selection.
#### Parameters #### Parameters
@@ -235,7 +253,7 @@ The pricing context
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L69) [medusa/src/services/pricing.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L65)
___ ___
@@ -261,7 +279,7 @@ A map of variant ids to their corresponding prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:389](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L389) [medusa/src/services/pricing.ts:388](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L388)
___ ___
@@ -286,7 +304,7 @@ A map of variant ids to their corresponding prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:407](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L407) [medusa/src/services/pricing.ts:406](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L406)
___ ___
@@ -308,7 +326,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:351](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L351) [medusa/src/services/pricing.ts:349](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L349)
___ ___
@@ -333,7 +351,7 @@ The product variant prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L214) [medusa/src/services/pricing.ts:212](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L212)
___ ___
@@ -362,7 +380,7 @@ The product variant prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:253](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L253) [medusa/src/services/pricing.ts:251](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L251)
___ ___
@@ -384,7 +402,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L167) [medusa/src/services/pricing.ts:163](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L163)
___ ___
@@ -416,7 +434,7 @@ The product variant prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:294](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L294) [medusa/src/services/pricing.ts:292](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L292)
___ ___
@@ -441,7 +459,7 @@ The shipping option prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:493](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L493) [medusa/src/services/pricing.ts:486](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L486)
___ ___
@@ -466,7 +484,7 @@ A list of products with variants decorated with prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L450) [medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L450)
___ ___
@@ -491,13 +509,13 @@ A list of shipping options with prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:555](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L555) [medusa/src/services/pricing.ts:548](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L548)
___ ___
### setVariantPrices ### setVariantPrices
▸ **setVariantPrices**(`variants`, `context`): `Promise`<`PricedVariant`[]\> ▸ **setVariantPrices**(`variants`, `context?`): `Promise`<`PricedVariant`[]\>
Set additional prices on a list of product variants. Set additional prices on a list of product variants.
@@ -516,7 +534,7 @@ A list of products with variants decorated with prices
#### Defined in #### Defined in
[packages/medusa/src/services/pricing.ts:425](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/pricing.ts#L425) [medusa/src/services/pricing.ts:424](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/pricing.ts#L424)
___ ___
@@ -540,7 +558,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -564,4 +582,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ProductCategoryService.md
+139 -31
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:35](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L35) [medusa/src/services/product-category.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L40)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L25) [medusa/src/services/product-category.ts:32](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L32)
___ ___
@@ -86,23 +86,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L27) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### productCategoryRepo\_ ### productCategoryRepo\_
• `Protected` `Readonly` **productCategoryRepo\_**: typeof `ProductCategoryRepository` • `Protected` `Readonly` **productCategoryRepo\_**: `TreeRepository`<`ProductCategory`\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<`ProductCategory`\>, `treeScope`: `QuerySelector`<`ProductCategory`\>) => `Promise`<``null`` \| `ProductCategory`\> ; `getFreeTextSearchResultsAndCount`: (`options`: `ExtendedFindConfig`<`ProductCategory`\>, `q?`: `string`, `treeScope`: `QuerySelector`<`ProductCategory`\>, `includeTree`: `boolean`) => `Promise`<[`ProductCategory`[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L24) [medusa/src/services/product-category.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L31)
___ ___
@@ -110,13 +110,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L26) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -134,7 +134,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L29) [medusa/src/services/product-category.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L34)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -159,7 +177,7 @@ the product category on which the products have been added
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:227](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L227) [medusa/src/services/product-category.ts:266](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L266)
___ ___
@@ -198,7 +216,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -210,9 +228,9 @@ Creates a product category
#### Parameters #### Parameters
| Name | Type | | Name | Type | Description |
| :------ | :------ | | :------ | :------ | :------ |
| `productCategoryInput` | `CreateProductCategoryInput` | | `productCategoryInput` | `CreateProductCategoryInput` | parameters to create a product category |
#### Returns #### Returns
@@ -222,7 +240,7 @@ created product category
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:132](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L132) [medusa/src/services/product-category.ts:139](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L139)
___ ___
@@ -246,7 +264,29 @@ a promise
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:191](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L191) [medusa/src/services/product-category.ts:220](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L220)
___
### fetchReorderConditions
▸ `Protected` **fetchReorderConditions**(`productCategory`, `input`, `shouldDeleteElement?`): `ReorderConditions`
#### Parameters
| Name | Type | Default value |
| :------ | :------ | :------ |
| `productCategory` | `ProductCategory` | `undefined` |
| `input` | `UpdateProductCategoryInput` | `undefined` |
| `shouldDeleteElement` | `boolean` | `false` |
#### Returns
`ReorderConditions`
#### Defined in
[medusa/src/services/product-category.ts:301](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L301)
___ ___
@@ -259,11 +299,11 @@ product category that match the query.
#### Parameters #### Parameters
| Name | Type | | Name | Type | Description |
| :------ | :------ | | :------ | :------ | :------ |
| `selector` | `QuerySelector`<`ProductCategory`\> | | `selector` | `TreeQuerySelector`<`ProductCategory`\> | Filter options for product category. |
| `config` | `FindConfig`<`ProductCategory`\> | | `config` | `FindConfig`<`ProductCategory`\> | Configuration for query. |
| `treeSelector` | `QuerySelector`<`ProductCategory`\> | | `treeSelector` | `QuerySelector`<`ProductCategory`\> | Filter options for product category tree relations |
#### Returns #### Returns
@@ -275,7 +315,28 @@ an array containing the product category as
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L55) [medusa/src/services/product-category.ts:61](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L61)
___
### performReordering
▸ `Protected` **performReordering**(`repository`, `conditions`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `repository` | `TreeRepository`<`ProductCategory`\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<`ProductCategory`\>, `treeScope`: `QuerySelector`<`ProductCategory`\>) => `Promise`<``null`` \| `ProductCategory`\> ; `getFreeTextSearchResultsAndCount`: (`options`: `ExtendedFindConfig`<`ProductCategory`\>, `q?`: `string`, `treeScope`: `QuerySelector`<`ProductCategory`\>, `includeTree`: `boolean`) => `Promise`<[`ProductCategory`[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } |
| `conditions` | `ReorderConditions` |
#### Returns
`Promise`<`void`\>
#### Defined in
[medusa/src/services/product-category.ts:329](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L329)
___ ___
@@ -300,13 +361,13 @@ the product category on which the products have been removed
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:245](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L245) [medusa/src/services/product-category.ts:285](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L285)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`productCategoryId`, `config?`, `selector?`): `Promise`<`ProductCategory`\> ▸ **retrieve**(`productCategoryId`, `config?`, `selector?`, `treeSelector?`): `Promise`<`ProductCategory`\>
Retrieves a product category by id. Retrieves a product category by id.
@@ -317,6 +378,7 @@ Retrieves a product category by id.
| `productCategoryId` | `string` | the id of the product category to retrieve. | | `productCategoryId` | `string` | the id of the product category to retrieve. |
| `config` | `FindConfig`<`ProductCategory`\> | the config of the product category to retrieve. | | `config` | `FindConfig`<`ProductCategory`\> | the config of the product category to retrieve. |
| `selector` | `Selector`<`ProductCategory`\> | - | | `selector` | `Selector`<`ProductCategory`\> | - |
| `treeSelector` | `QuerySelector`<`ProductCategory`\> | - |
#### Returns #### Returns
@@ -326,7 +388,28 @@ the product category.
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:92](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L92) [medusa/src/services/product-category.ts:100](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L100)
___
### shiftSiblings
▸ `Protected` **shiftSiblings**(`repository`, `conditions`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `repository` | `TreeRepository`<`ProductCategory`\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<`ProductCategory`\>, `treeScope`: `QuerySelector`<`ProductCategory`\>) => `Promise`<``null`` \| `ProductCategory`\> ; `getFreeTextSearchResultsAndCount`: (`options`: `ExtendedFindConfig`<`ProductCategory`\>, `q?`: `string`, `treeScope`: `QuerySelector`<`ProductCategory`\>, `includeTree`: `boolean`) => `Promise`<[`ProductCategory`[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } |
| `conditions` | `ReorderConditions` |
#### Returns
`Promise`<`void`\>
#### Defined in
[medusa/src/services/product-category.ts:367](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L367)
___ ___
@@ -350,7 +433,32 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### transformParentIdToEntity
▸ `Protected` **transformParentIdToEntity**(`productCategoryInput`): `Promise`<`CreateProductCategoryInput` \| `UpdateProductCategoryInput`\>
Accepts an input object and transforms product_category_id
into product_category entity.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productCategoryInput` | `CreateProductCategoryInput` \| `UpdateProductCategoryInput` | params used to create/update |
#### Returns
`Promise`<`CreateProductCategoryInput` \| `UpdateProductCategoryInput`\>
transformed productCategoryInput
#### Defined in
[medusa/src/services/product-category.ts:465](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L465)
___ ___
@@ -375,7 +483,7 @@ updated product category
#### Defined in #### Defined in
[packages/medusa/src/services/product-category.ts:156](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-category.ts#L156) [medusa/src/services/product-category.ts:173](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-category.ts#L173)
___ ___
@@ -399,4 +507,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ProductCollectionService.md
+64 -26
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L34) [medusa/src/services/product-collection.ts:49](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L49)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L29) [medusa/src/services/product-collection.ts:36](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L36)
___ ___
@@ -86,33 +86,33 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L26) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### productCollectionRepository\_ ### productCollectionRepository\_
• `Protected` `Readonly` **productCollectionRepository\_**: typeof `ProductCollectionRepository` • `Protected` `Readonly` **productCollectionRepository\_**: `Repository`<`ProductCollection`\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: `ExtendedFindConfig`<`ProductCollection`\>) => `Promise`<[`ProductCollection`[], `number`]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L31) [medusa/src/services/product-collection.ts:38](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L38)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: typeof `ProductRepository` • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findAndCount`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<[`Product`[], `number`]\> ; `findOne`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>) => `Promise`<``null`` \| `Product`\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `prepareQueryBuilder_`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<`SelectQueryBuilder`<`Product`\>\> ; `upsertShippingProfile`: (`productIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L32) [medusa/src/services/product-collection.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L39)
___ ___
@@ -120,13 +120,51 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L27) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `CREATED` | `string` |
| `DELETED` | `string` |
| `PRODUCTS_ADDED` | `string` |
| `PRODUCTS_REMOVED` | `string` |
| `UPDATED` | `string` |
#### Defined in
[medusa/src/services/product-collection.ts:41](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L41)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -147,7 +185,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:181](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L181) [medusa/src/services/product-collection.ts:216](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L216)
___ ___
@@ -186,7 +224,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -210,7 +248,7 @@ created collection
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:114](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L114) [medusa/src/services/product-collection.ts:128](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L128)
___ ___
@@ -234,7 +272,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:163](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L163) [medusa/src/services/product-collection.ts:192](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L192)
___ ___
@@ -261,7 +299,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:219](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L219) [medusa/src/services/product-collection.ts:274](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L274)
___ ___
@@ -275,7 +313,7 @@ Lists product collections and add count.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `Selector`<`ProductCollection`\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find | | `selector` | `ListAndCountSelector` | the query object for find |
| `config` | `FindConfig`<`ProductCollection`\> | the config to be used for find | | `config` | `FindConfig`<`ProductCollection`\> | the config to be used for find |
#### Returns #### Returns
@@ -286,7 +324,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:236](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L236) [medusa/src/services/product-collection.ts:291](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L291)
___ ___
@@ -307,7 +345,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:198](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L198) [medusa/src/services/product-collection.ts:242](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L242)
___ ___
@@ -332,7 +370,7 @@ the collection.
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L54) [medusa/src/services/product-collection.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L68)
___ ___
@@ -357,7 +395,7 @@ the collection.
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:88](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L88) [medusa/src/services/product-collection.ts:102](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L102)
___ ___
@@ -381,7 +419,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -406,7 +444,7 @@ update collection
#### Defined in #### Defined in
[packages/medusa/src/services/product-collection.ts:133](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-collection.ts#L133) [medusa/src/services/product-collection.ts:154](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-collection.ts#L154)
___ ___
@@ -430,4 +468,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ProductService.md
+72 -86
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:78](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L78) [medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L71)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L68) [medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L61)
___ ___
@@ -86,17 +86,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L69) [medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L62)
___ ___
### imageRepository\_ ### imageRepository\_
• `Protected` `Readonly` **imageRepository\_**: typeof `ImageRepository` • `Protected` `Readonly` **imageRepository\_**: `Repository`<`Image`\> & { `insertBulk`: (`data`: `_QueryDeepPartialEntity`<`Image`\>[]) => `Promise`<`Image`[]\> ; `upsertImages`: (`imageUrls`: `string`[]) => `Promise`<`Image`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L63) [medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L56)
___ ___
@@ -104,73 +104,73 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L55) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### productCategoryRepository\_ ### productCategoryRepository\_
• `Protected` `Readonly` **productCategoryRepository\_**: typeof `ProductCategoryRepository` • `Protected` `Readonly` **productCategoryRepository\_**: `TreeRepository`<`ProductCategory`\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<`ProductCategory`\>, `treeScope`: `QuerySelector`<`ProductCategory`\>) => `Promise`<``null`` \| `ProductCategory`\> ; `getFreeTextSearchResultsAndCount`: (`options`: `ExtendedFindConfig`<`ProductCategory`\>, `q?`: `string`, `treeScope`: `QuerySelector`<`ProductCategory`\>, `includeTree`: `boolean`) => `Promise`<[`ProductCategory`[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L65) [medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L58)
___ ___
### productOptionRepository\_ ### productOptionRepository\_
• `Protected` `Readonly` **productOptionRepository\_**: typeof `ProductOptionRepository` • `Protected` `Readonly` **productOptionRepository\_**: `Repository`<`ProductOption`\>
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L58) [medusa/src/services/product.ts:51](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L51)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: typeof `ProductRepository` • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findAndCount`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<[`Product`[], `number`]\> ; `findOne`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>) => `Promise`<``null`` \| `Product`\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `prepareQueryBuilder_`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<`SelectQueryBuilder`<`Product`\>\> ; `upsertShippingProfile`: (`productIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L59) [medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L52)
___ ___
### productTagRepository\_ ### productTagRepository\_
• `Protected` `Readonly` **productTagRepository\_**: typeof `ProductTagRepository` • `Protected` `Readonly` **productTagRepository\_**: `Repository`<`ProductTag`\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: `ExtendedFindConfig`<`ProductTag`\>) => `Promise`<[`ProductTag`[], `number`]\> ; `listTagsByUsage`: (`count`: `number`) => `Promise`<`ProductTag`[]\> ; `upsertTags`: (`tags`: `UpsertTagsInput`) => `Promise`<`ProductTag`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L62) [medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L55)
___ ___
### productTypeRepository\_ ### productTypeRepository\_
• `Protected` `Readonly` **productTypeRepository\_**: typeof `ProductTypeRepository` • `Protected` `Readonly` **productTypeRepository\_**: `Repository`<`ProductType`\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: `ExtendedFindConfig`<`ProductType`\>) => `Promise`<[`ProductType`[], `number`]\> ; `upsertType`: (`type?`: `UpsertTypeInput`) => `Promise`<``null`` \| `ProductType`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L61) [medusa/src/services/product.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L54)
___ ___
### productVariantRepository\_ ### productVariantRepository\_
• `Protected` `Readonly` **productVariantRepository\_**: typeof `ProductVariantRepository` • `Protected` `Readonly` **productVariantRepository\_**: `Repository`<`ProductVariant`\>
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L60) [medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L53)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L66) [medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L59)
___ ___
@@ -190,7 +190,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L67) [medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L60)
___ ___
@@ -198,13 +198,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -222,7 +222,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:72](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L72) [medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L65)
___ ___
@@ -232,7 +232,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L71) [medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L64)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -259,7 +277,7 @@ the result of the model update operation
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:656](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L656) [medusa/src/services/product.ts:637](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L637)
___ ___
@@ -298,7 +316,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -322,7 +340,7 @@ the result of the count operation
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:171](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L171) [medusa/src/services/product.ts:158](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L158)
___ ___
@@ -346,7 +364,7 @@ resolves to the creation result.
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:383](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L383) [medusa/src/services/product.ts:365](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L365)
___ ___
@@ -371,7 +389,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:622](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L622) [medusa/src/services/product.ts:598](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L598)
___ ___
@@ -396,7 +414,7 @@ the updated product
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:821](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L821) [medusa/src/services/product.ts:802](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L802)
___ ___
@@ -418,7 +436,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:306](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L306) [medusa/src/services/product.ts:290](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L290)
___ ___
@@ -441,7 +459,7 @@ Check if the product is assigned to at least one of the provided sales channels.
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:361](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L361) [medusa/src/services/product.ts:343](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L343)
___ ___
@@ -466,7 +484,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:117](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L117) [medusa/src/services/product.ts:108](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L108)
___ ___
@@ -494,7 +512,7 @@ an array containing the products as
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:141](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L141) [medusa/src/services/product.ts:132](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L132)
___ ___
@@ -514,7 +532,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:346](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L346) [medusa/src/services/product.ts:329](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L329)
___ ___
@@ -528,39 +546,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:337](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L337) [medusa/src/services/product.ts:321](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L321)
___
### prepareListQuery\_
▸ `Protected` **prepareListQuery_**(`selector`, `config`): `Object`
Creates a query object to be used for list queries.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | the selector to create the query from |
| `config` | `FindProductConfig` | the config to use for the query |
#### Returns
`Object`
an object containing the query, relations and free-text
search param.
| Name | Type |
| :------ | :------ |
| `q` | `string` |
| `query` | `FindWithoutRelationsOptions` |
| `relations` | keyof `Product`[] |
#### Defined in
[packages/medusa/src/services/product.ts:918](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L918)
___ ___
@@ -581,7 +567,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:699](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L699) [medusa/src/services/product.ts:680](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L680)
___ ___
@@ -607,7 +593,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:186](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L186) [medusa/src/services/product.ts:174](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L174)
___ ___
@@ -633,7 +619,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:230](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L230) [medusa/src/services/product.ts:218](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L218)
___ ___
@@ -659,13 +645,13 @@ the result of the find one operation.
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L209) [medusa/src/services/product.ts:197](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L197)
___ ___
### retrieveOptionByTitle ### retrieveOptionByTitle
▸ **retrieveOptionByTitle**(`title`, `productId`): `Promise`<`undefined` \| `ProductOption`\> ▸ **retrieveOptionByTitle**(`title`, `productId`): `Promise`<``null`` \| `ProductOption`\>
Retrieve product's option by title. Retrieve product's option by title.
@@ -678,13 +664,13 @@ Retrieve product's option by title.
#### Returns #### Returns
`Promise`<`undefined` \| `ProductOption`\> `Promise`<``null`` \| `ProductOption`\>
product option product option
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:802](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L802) [medusa/src/services/product.ts:783](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L783)
___ ___
@@ -709,7 +695,7 @@ an array of variants
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:288](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L288) [medusa/src/services/product.ts:272](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L272)
___ ___
@@ -735,7 +721,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:252](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L252) [medusa/src/services/product.ts:240](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L240)
___ ___
@@ -759,7 +745,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -786,7 +772,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:492](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L492) [medusa/src/services/product.ts:470](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L470)
___ ___
@@ -813,7 +799,7 @@ the updated product
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:745](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L745) [medusa/src/services/product.ts:726](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L726)
___ ___
@@ -836,7 +822,7 @@ updated shipping options
#### Defined in #### Defined in
[packages/medusa/src/services/product.ts:892](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product.ts#L892) [medusa/src/services/product.ts:873](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product.ts#L873)
___ ___
@@ -860,4 +846,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ProductTypeService.md
+34 -16
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-type.ts#L15) [medusa/src/services/product-type.ts:12](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-type.ts#L12)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -74,13 +74,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-type.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -88,23 +88,41 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-type.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
### typeRepository\_ ### typeRepository\_
• `Protected` `Readonly` **typeRepository\_**: typeof `ProductTypeRepository` • `Protected` `Readonly` **typeRepository\_**: `Repository`<`ProductType`\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: `ExtendedFindConfig`<`ProductType`\>) => `Promise`<[`ProductType`[], `number`]\> ; `upsertType`: (`type?`: `UpsertTypeInput`) => `Promise`<``null`` \| `ProductType`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product-type.ts:13](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-type.ts#L13) [medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-type.ts#L10)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -143,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -168,7 +186,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-type.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-type.ts#L55) [medusa/src/services/product-type.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-type.ts#L52)
___ ___
@@ -193,7 +211,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-type.ts#L72) [medusa/src/services/product-type.ts:69](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-type.ts#L69)
___ ___
@@ -219,7 +237,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[packages/medusa/src/services/product-type.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-type.ts#L30) [medusa/src/services/product-type.ts:27](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-type.ts#L27)
___ ___
@@ -243,7 +261,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -267,4 +285,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ProductVariantInventoryService.md
+82 -36
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L43) [medusa/src/services/product-variant-inventory.ts:36](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L36)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) utils/dist/common/transaction-base-service.d.ts:5
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) utils/dist/common/transaction-base-service.d.ts:4
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) utils/dist/common/transaction-base-service.d.ts:6
___ ___
### cacheService\_ ### cacheService\_
• `Protected` `Readonly` **cacheService\_**: [`CacheService`](CacheService.md) • `Protected` `Readonly` **cacheService\_**: `ICacheService`
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L41) [medusa/src/services/product-variant-inventory.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L34)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L40) [medusa/src/services/product-variant-inventory.ts:33](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L33)
___ ___
@@ -94,13 +94,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:33](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L33) utils/dist/common/transaction-base-service.d.ts:7
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L38) [medusa/src/services/product-variant-inventory.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L31)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L37) [medusa/src/services/product-variant-inventory.ts:30](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L30)
___ ___
@@ -130,7 +130,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:36](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L36) [medusa/src/services/product-variant-inventory.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L29)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:39](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L39) [medusa/src/services/product-variant-inventory.ts:32](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L32)
___ ___
@@ -148,13 +148,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L34) utils/dist/common/transaction-base-service.d.ts:8
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:9
## Methods ## Methods
@@ -178,7 +196,7 @@ Adjusts inventory of a variant on a location
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:573](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L573) [medusa/src/services/product-variant-inventory.ts:598](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L598)
___ ___
@@ -203,7 +221,7 @@ Adjusts the quantity of reservations for a line item by a given amount.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:419](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L419) [medusa/src/services/product-variant-inventory.ts:408](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L408)
___ ___
@@ -242,7 +260,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) utils/dist/common/transaction-base-service.d.ts:24
___ ___
@@ -268,7 +286,7 @@ the variant inventory item
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:255](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L255) [medusa/src/services/product-variant-inventory.ts:237](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L237)
___ ___
@@ -295,7 +313,7 @@ boolean indicating if inventory is available
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L69) [medusa/src/services/product-variant-inventory.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L60)
___ ___
@@ -319,7 +337,7 @@ delete a reservation of variant quantity
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:538](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L538) [medusa/src/services/product-variant-inventory.ts:566](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L566)
___ ___
@@ -342,7 +360,35 @@ Remove a variant from an inventory item
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:317](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L317) [medusa/src/services/product-variant-inventory.ts:299](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L299)
___
### getVariantQuantityFromVariantInventoryItems
▸ **getVariantQuantityFromVariantInventoryItems**(`variantInventoryItems`, `channelId`): `Promise`<`number`\>
Get the quantity of a variant from a list of variantInventoryItems
The inventory quantity of the variant should be equal to the inventory
item with the smallest stock, adjusted for quantity required to fulfill
the given variant.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantInventoryItems` | `ProductVariantInventoryItem`[] | List of inventoryItems for a given variant, These must all be for the same variant |
| `channelId` | `string` | Sales channel id to fetch availability for |
#### Returns
`Promise`<`number`\>
The available quantity of the variant from the inventoryItems
#### Defined in
[medusa/src/services/product-variant-inventory.ts:716](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L716)
___ ___
@@ -366,13 +412,13 @@ list of inventory items
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:173](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L173) [medusa/src/services/product-variant-inventory.ts:159](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L159)
___ ___
### listByVariant ### listByVariant
▸ `Private` **listByVariant**(`variantId`): `Promise`<`ProductVariantInventoryItem`[]\> ▸ **listByVariant**(`variantId`): `Promise`<`ProductVariantInventoryItem`[]\>
List inventory items for a specific variant List inventory items for a specific variant
@@ -390,7 +436,7 @@ variant inventory items for the variant id
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:192](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L192) [medusa/src/services/product-variant-inventory.ts:176](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L176)
___ ___
@@ -414,7 +460,7 @@ lidt of inventory items for the variant
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:233](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L233) [medusa/src/services/product-variant-inventory.ts:215](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L215)
___ ___
@@ -438,7 +484,7 @@ a list of product variants that are associated with the item id
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:215](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L215) [medusa/src/services/product-variant-inventory.ts:197](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L197)
___ ___
@@ -462,7 +508,7 @@ Reserves a quantity of a variant
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:349](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L349) [medusa/src/services/product-variant-inventory.ts:329](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L329)
___ ___
@@ -487,7 +533,7 @@ A promise that resolves with the product variant inventory item.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:144](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L144) [medusa/src/services/product-variant-inventory.ts:132](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L132)
___ ___
@@ -500,7 +546,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `products` | (`Product` \| `PricedProduct`)[] | | `products` | (`Product` \| `PricedProduct`)[] |
| `salesChannelId` | `undefined` \| `string` | | `salesChannelId` | `undefined` \| `string` \| `string`[] |
#### Returns #### Returns
@@ -508,7 +554,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:665](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L665) [medusa/src/services/product-variant-inventory.ts:686](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L686)
___ ___
@@ -521,7 +567,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `variants` | `ProductVariant`[] \| `PricedVariant`[] | | `variants` | `ProductVariant`[] \| `PricedVariant`[] |
| `salesChannelId` | `undefined` \| `string` | | `salesChannelId` | `undefined` \| `string` \| `string`[] |
#### Returns #### Returns
@@ -529,7 +575,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:617](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L617) [medusa/src/services/product-variant-inventory.ts:639](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L639)
___ ___
@@ -553,7 +599,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) utils/dist/common/transaction-base-service.d.ts:12
___ ___
@@ -578,7 +624,7 @@ nothing if successful, throws error if not
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant-inventory.ts:492](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant-inventory.ts#L492) [medusa/src/services/product-variant-inventory.ts:509](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant-inventory.ts#L509)
___ ___
@@ -602,4 +648,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) utils/dist/common/transaction-base-service.d.ts:11
docs/content/references/services/classes/ProductVariantService.md
+105 -119
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:72](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L72) [medusa/src/services/product-variant.ts:75](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L75)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,17 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### cartRepository\_ ### cartRepository\_
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository` • `Protected` `Readonly` **cartRepository\_**: `Repository`<`Cart`\>
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:70](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L70) [medusa/src/services/product-variant.ts:73](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L73)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L64) [medusa/src/services/product-variant.ts:67](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L67)
___ ___
@@ -94,23 +94,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L59) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### moneyAmountRepository\_ ### moneyAmountRepository\_
• `Protected` `Readonly` **moneyAmountRepository\_**: typeof `MoneyAmountRepository` • `Protected` `Readonly` **moneyAmountRepository\_**: `Repository`<`MoneyAmount`\> & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: `PriceListPriceCreateInput`[], `overrideExisting`: `boolean`) => `Promise`<`MoneyAmount`[]\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: `ProductVariantPrice`[] ; `variantId`: `string` }[], `prices?`: `Price`[]) => `Promise`<`void`\> ; `findManyForVariantInPriceList`: (`variant_id`: `string`, `price_list_id`: `string`, `requiresPriceList`: `boolean`) => `Promise`<[`MoneyAmount`[], `number`]\> ; `findManyForVariantInRegion`: (`variant_id`: `string`, `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing`: `boolean`) => `Promise`<[`MoneyAmount`[], `number`]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: `Price`[]) => `Promise`<`MoneyAmount`[]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<`MoneyAmount`\>[]) => `Promise`<`MoneyAmount`[]\> ; `updatePriceListPrices`: (`priceListId`: `string`, `updates`: `PriceListPriceUpdateInput`[]) => `Promise`<`MoneyAmount`[]\> ; `upsertVariantCurrencyPrice`: (`variantId`: `string`, `price`: `Price`) => `Promise`<`MoneyAmount`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L67) [medusa/src/services/product-variant.ts:70](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L70)
___ ___
@@ -120,37 +120,37 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:66](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L66) [medusa/src/services/product-variant.ts:69](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L69)
___ ___
### productOptionValueRepository\_ ### productOptionValueRepository\_
• `Protected` `Readonly` **productOptionValueRepository\_**: typeof `ProductOptionValueRepository` • `Protected` `Readonly` **productOptionValueRepository\_**: `Repository`<`ProductOptionValue`\>
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L69) [medusa/src/services/product-variant.ts:72](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L72)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: typeof `ProductRepository` • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findAndCount`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<[`Product`[], `number`]\> ; `findOne`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>) => `Promise`<``null`` \| `Product`\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `prepareQueryBuilder_`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<`SelectQueryBuilder`<`Product`\>\> ; `upsertShippingProfile`: (`productIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L63) [medusa/src/services/product-variant.ts:66](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L66)
___ ___
### productVariantRepository\_ ### productVariantRepository\_
• `Protected` `Readonly` **productVariantRepository\_**: typeof `ProductVariantRepository` • `Protected` `Readonly` **productVariantRepository\_**: `Repository`<`ProductVariant`\>
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L62) [medusa/src/services/product-variant.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L65)
___ ___
@@ -160,7 +160,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L65) [medusa/src/services/product-variant.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L68)
___ ___
@@ -168,13 +168,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L60) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -192,7 +192,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L53) [medusa/src/services/product-variant.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L59)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -222,47 +240,7 @@ the result of the update operation.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:823](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L823) [medusa/src/services/product-variant.ts:840](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L840)
___
### addOrUpdateCurrencyPrices
▸ **addOrUpdateCurrencyPrices**(`data`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | { `price`: `WithRequiredProperty`<`ProductVariantPrice`, ``"currency_code"``\> ; `variantId`: `string` }[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/product-variant.ts:613](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L613)
___
### addOrUpdateRegionPrices
▸ **addOrUpdateRegionPrices**(`data`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `UpdateVariantRegionPriceData`[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[packages/medusa/src/services/product-variant.ts:542](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L542)
___ ___
@@ -301,7 +279,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -327,7 +305,7 @@ resolves to the creation result.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:167](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L167) [medusa/src/services/product-variant.ts:168](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L168)
___ ___
@@ -352,7 +330,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:976](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L976) [medusa/src/services/product-variant.ts:1010](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L1010)
___ ___
@@ -378,7 +356,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:850](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L850) [medusa/src/services/product-variant.ts:867](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L867)
___ ___
@@ -393,7 +371,7 @@ variants that match the query.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `variantRepo` | `ProductVariantRepository` | the variant repository | | `variantRepo` | `Repository`<`ProductVariant`\> | the variant repository |
| `query` | `FindWithRelationsOptions` | object that defines the scope for what should be returned | | `query` | `FindWithRelationsOptions` | object that defines the scope for what should be returned |
| `q?` | `string` | free text query | | `q?` | `string` | free text query |
@@ -406,7 +384,7 @@ an array containing the products as the first element and the total
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:1078](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L1078) [medusa/src/services/product-variant.ts:1073](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L1073)
___ ___
@@ -433,7 +411,7 @@ the price specific to the region
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:697](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L697) [medusa/src/services/product-variant.ts:714](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L714)
___ ___
@@ -456,7 +434,7 @@ Check if the variant is assigned to at least one of the provided sales channels.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:1016](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L1016) [medusa/src/services/product-variant.ts:1048](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L1048)
___ ___
@@ -479,7 +457,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:918](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L918) [medusa/src/services/product-variant.ts:956](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L956)
___ ___
@@ -502,39 +480,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:877](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L877) [medusa/src/services/product-variant.ts:895](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L895)
___
### prepareListQuery\_
▸ **prepareListQuery_**(`selector`, `config`): `Object`
Creates a query object to be used for list queries.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductVariantProps` | the selector to create the query from |
| `config` | `FindConfig`<`ProductVariant`\> | the config to use for the query |
#### Returns
`Object`
an object containing the query, relations and free-text
search param.
| Name | Type |
| :------ | :------ |
| `q?` | `string` |
| `query` | `FindWithRelationsOptions` |
| `relations` | `string`[] |
#### Defined in
[packages/medusa/src/services/product-variant.ts:1039](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L1039)
___ ___
@@ -559,7 +505,7 @@ the product document.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:103](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L103) [medusa/src/services/product-variant.ts:104](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L104)
___ ___
@@ -584,7 +530,7 @@ the product document.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:131](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L131) [medusa/src/services/product-variant.ts:132](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L132)
___ ___
@@ -612,7 +558,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:764](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L764) [medusa/src/services/product-variant.ts:781](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L781)
___ ___
@@ -640,7 +586,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:727](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L727) [medusa/src/services/product-variant.ts:744](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L744)
___ ___
@@ -664,7 +610,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -688,7 +634,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:264](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L264) [medusa/src/services/product-variant.ts:269](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L269)
▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\> ▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\>
@@ -711,7 +657,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:279](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L279) [medusa/src/services/product-variant.ts:284](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L284)
▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\> ▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\>
@@ -728,7 +674,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:284](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L284) [medusa/src/services/product-variant.ts:289](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L289)
___ ___
@@ -748,7 +694,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:340](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L340) [medusa/src/services/product-variant.ts:343](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L343)
___ ___
@@ -775,7 +721,7 @@ the result of the update operation.
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:785](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L785) [medusa/src/services/product-variant.ts:802](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L802)
___ ___
@@ -800,7 +746,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:440](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L440) [medusa/src/services/product-variant.ts:441](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L441)
▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\> ▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\>
@@ -822,7 +768,7 @@ empty promise
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:449](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L449) [medusa/src/services/product-variant.ts:450](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L450)
___ ___
@@ -842,7 +788,47 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/product-variant.ts:469](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/product-variant.ts#L469) [medusa/src/services/product-variant.ts:470](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L470)
___
### upsertCurrencyPrices
▸ **upsertCurrencyPrices**(`data`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | { `price`: `WithRequiredProperty`<`ProductVariantPrice`, ``"currency_code"``\> ; `variantId`: `string` }[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[medusa/src/services/product-variant.ts:622](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L622)
___
### upsertRegionPrices
▸ **upsertRegionPrices**(`data`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `UpdateVariantRegionPriceData`[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[medusa/src/services/product-variant.ts:543](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/product-variant.ts#L543)
___ ___
@@ -866,4 +852,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/RegionService.md
+66 -48
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L67) [medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L65)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,27 +68,27 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### countryRepository\_ ### countryRepository\_
• `Protected` `Readonly` **countryRepository\_**: typeof `CountryRepository` • `Protected` `Readonly` **countryRepository\_**: `Repository`<`Country`\>
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L59) [medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L57)
___ ___
### currencyRepository\_ ### currencyRepository\_
• `Protected` `Readonly` **currencyRepository\_**: typeof `CurrencyRepository` • `Protected` `Readonly` **currencyRepository\_**: `Repository`<`Currency`\>
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L60) [medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L58)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L54) [medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L52)
___ ___
@@ -108,17 +108,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L52) [medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L50)
___ ___
### fulfillmentProviderRepository\_ ### fulfillmentProviderRepository\_
• `Protected` `Readonly` **fulfillmentProviderRepository\_**: typeof `FulfillmentProviderRepository` • `Protected` `Readonly` **fulfillmentProviderRepository\_**: `Repository`<`FulfillmentProvider`\>
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L64) [medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L62)
___ ___
@@ -128,7 +128,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L57) [medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L55)
___ ___
@@ -136,23 +136,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### paymentProviderRepository\_ ### paymentProviderRepository\_
• `Protected` `Readonly` **paymentProviderRepository\_**: typeof `PaymentProviderRepository` • `Protected` `Readonly` **paymentProviderRepository\_**: `Repository`<`PaymentProvider`\>
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L62) [medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L60)
___ ___
@@ -162,17 +162,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L56) [medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L54)
___ ___
### regionRepository\_ ### regionRepository\_
• `Protected` `Readonly` **regionRepository\_**: typeof `RegionRepository` • `Protected` `Readonly` **regionRepository\_**: `Repository`<`Region`\>
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L58) [medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L56)
___ ___
@@ -182,17 +182,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L55) [medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L53)
___ ___
### taxProviderRepository\_ ### taxProviderRepository\_
• `Protected` `Readonly` **taxProviderRepository\_**: typeof `TaxProviderRepository` • `Protected` `Readonly` **taxProviderRepository\_**: `Repository`<`TaxProvider`\>
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L65) [medusa/src/services/region.ts:63](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L63)
___ ___
@@ -200,13 +200,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L51) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -224,7 +224,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L44) [medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L44)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -249,7 +267,7 @@ the updated Region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:580](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L580) [medusa/src/services/region.ts:559](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L559)
___ ___
@@ -275,7 +293,7 @@ the updated Region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:710](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L710) [medusa/src/services/region.ts:687](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L687)
___ ___
@@ -301,7 +319,7 @@ the updated Region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:659](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L659) [medusa/src/services/region.ts:638](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L638)
___ ___
@@ -340,7 +358,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -364,7 +382,7 @@ the newly created region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L117) [medusa/src/services/region.ts:101](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L101)
___ ___
@@ -388,7 +406,7 @@ the result of the delete operation
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:549](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L549) [medusa/src/services/region.ts:528](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L528)
___ ___
@@ -413,7 +431,7 @@ result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:529](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L529) [medusa/src/services/region.ts:506](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L506)
___ ___
@@ -438,7 +456,7 @@ the updated Region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:618](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L618) [medusa/src/services/region.ts:597](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L597)
___ ___
@@ -463,7 +481,7 @@ the updated Region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:798](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L798) [medusa/src/services/region.ts:773](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L773)
___ ___
@@ -488,7 +506,7 @@ the updated Region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:759](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L759) [medusa/src/services/region.ts:734](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L734)
___ ___
@@ -513,7 +531,7 @@ the region
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L494) [medusa/src/services/region.ts:471](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L471)
___ ___
@@ -538,7 +556,7 @@ a Region with country code
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L437) [medusa/src/services/region.ts:417](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L417)
___ ___
@@ -562,7 +580,7 @@ region with the matching name
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L474) [medusa/src/services/region.ts:451](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L451)
___ ___
@@ -586,7 +604,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -611,7 +629,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L190) [medusa/src/services/region.ts:172](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L172)
___ ___
@@ -637,7 +655,7 @@ the validated Country
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L388) [medusa/src/services/region.ts:368](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L368)
___ ___
@@ -665,13 +683,13 @@ void
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L363) [medusa/src/services/region.ts:343](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L343)
___ ___
### validateFields ### validateFields
▸ `Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<{ `automatic_taxes?`: `boolean` ; `countries?`: (`undefined` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; })[] ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `currency?`: { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } ; `currency_code?`: `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `fulfillment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `gift_cards_taxable?`: `boolean` ; `id?`: `string` ; `includes_tax?`: `boolean` ; `metadata?`: { [x: string]: unknown; } ; `name?`: `string` ; `payment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `tax_code?`: `string` ; `tax_provider?`: { id?: string \| undefined; is\_installed?: boolean \| undefined; } ; `tax_provider_id?`: ``null`` \| `string` ; `tax_rate?`: `number` ; `tax_rates?`: ``null`` \| (`undefined` \| { rate?: number \| null \| undefined; code?: string \| null \| undefined; name?: string \| undefined; region\_id?: string \| undefined; region?: { name?: string \| undefined; currency\_code?: string \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 9 more ...; updated\_at?: { ...; } \| undefin...)[] ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } }\> ▸ `Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<`DeepPartial`<`Region`\>\>
Validates fields for creation and updates. If the region already exists Validates fields for creation and updates. If the region already exists
the id can be passed to check that country updates are allowed. the id can be passed to check that country updates are allowed.
@@ -691,13 +709,13 @@ the id can be passed to check that country updates are allowed.
#### Returns #### Returns
`Promise`<{ `automatic_taxes?`: `boolean` ; `countries?`: (`undefined` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; })[] ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `currency?`: { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } ; `currency_code?`: `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `fulfillment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `gift_cards_taxable?`: `boolean` ; `id?`: `string` ; `includes_tax?`: `boolean` ; `metadata?`: { [x: string]: unknown; } ; `name?`: `string` ; `payment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `tax_code?`: `string` ; `tax_provider?`: { id?: string \| undefined; is\_installed?: boolean \| undefined; } ; `tax_provider_id?`: ``null`` \| `string` ; `tax_rate?`: `number` ; `tax_rates?`: ``null`` \| (`undefined` \| { rate?: number \| null \| undefined; code?: string \| null \| undefined; name?: string \| undefined; region\_id?: string \| undefined; region?: { name?: string \| undefined; currency\_code?: string \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 9 more ...; updated\_at?: { ...; } \| undefin...)[] ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } }\> `Promise`<`DeepPartial`<`Region`\>\>
the validated region data the validated region data
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L261) [medusa/src/services/region.ts:241](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L241)
___ ___
@@ -725,7 +743,7 @@ void
#### Defined in #### Defined in
[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/region.ts#L347) [medusa/src/services/region.ts:327](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/region.ts#L327)
___ ___
@@ -749,4 +767,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ReturnReasonService.md
+36 -18
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L21) [medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return-reason.ts#L18)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -74,23 +74,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L18) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### retReasonRepo\_ ### retReasonRepo\_
• `Protected` `Readonly` **retReasonRepo\_**: typeof `ReturnReasonRepository` • `Protected` `Readonly` **retReasonRepo\_**: `Repository`<`ReturnReason`\>
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L16) [medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return-reason.ts#L16)
___ ___
@@ -98,13 +98,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L19) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -143,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -163,7 +181,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L29) [medusa/src/services/return-reason.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return-reason.ts#L25)
___ ___
@@ -183,7 +201,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:117](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L117) [medusa/src/services/return-reason.ts:113](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return-reason.ts#L113)
___ ___
@@ -206,7 +224,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L72) [medusa/src/services/return-reason.ts:68](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return-reason.ts#L68)
___ ___
@@ -231,7 +249,7 @@ the order document
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L91) [medusa/src/services/return-reason.ts:87](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return-reason.ts#L87)
___ ___
@@ -255,7 +273,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -276,7 +294,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return-reason.ts#L50) [medusa/src/services/return-reason.ts:46](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return-reason.ts#L46)
___ ___
@@ -300,4 +318,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ReturnService.md
+54 -80
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:67](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L67) [medusa/src/services/return.ts:64](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L64)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L61) [medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L58)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L58) [medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L55)
___ ___
@@ -94,13 +94,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L52) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L63) [medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L60)
___ ___
@@ -120,17 +120,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L65) [medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L62)
___ ___
### returnItemRepository\_ ### returnItemRepository\_
• `Protected` `Readonly` **returnItemRepository\_**: typeof `ReturnItemRepository` • `Protected` `Readonly` **returnItemRepository\_**: `Repository`<`ReturnItem`\>
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L57) [medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L54)
___ ___
@@ -140,17 +140,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L62) [medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L59)
___ ___
### returnRepository\_ ### returnRepository\_
• `Protected` `Readonly` **returnRepository\_**: typeof `ReturnRepository` • `Protected` `Readonly` **returnRepository\_**: `Repository`<`Return`\>
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L56) [medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L53)
___ ___
@@ -160,7 +160,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L60) [medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L57)
___ ___
@@ -170,7 +170,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L59) [medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L56)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L55) [medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L52)
___ ___
@@ -188,13 +188,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L53) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -233,7 +251,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -257,7 +275,7 @@ the updated Return
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:164](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L164) [medusa/src/services/return.ts:161](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L161)
___ ___
@@ -283,7 +301,7 @@ the created return
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:349](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L349) [medusa/src/services/return.ts:346](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L346)
___ ___
@@ -303,7 +321,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:495](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L495) [medusa/src/services/return.ts:490](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L490)
___ ___
@@ -329,7 +347,7 @@ the line items generated by the transformer.
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:106](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L106) [medusa/src/services/return.ts:101](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L101)
___ ___
@@ -352,7 +370,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:146](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L146) [medusa/src/services/return.ts:141](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L141)
___ ___
@@ -387,7 +405,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:566](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L566) [medusa/src/services/return.ts:561](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L561)
___ ___
@@ -412,7 +430,7 @@ the return
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:262](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L262) [medusa/src/services/return.ts:259](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L259)
___ ___
@@ -433,7 +451,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:290](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L290) [medusa/src/services/return.ts:287](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L287)
___ ___
@@ -457,7 +475,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -478,13 +496,13 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:315](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L315) [medusa/src/services/return.ts:312](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L312)
___ ___
### validateReturnLineItem ### validateReturnLineItem
▸ `Protected` **validateReturnLineItem**(`item?`, `quantity?`, `additional?`): `Object` ▸ `Protected` **validateReturnLineItem**(`item?`, `quantity?`, `additional?`): `DeepPartial`<`LineItem`\>
Checks that a given quantity of a line item can be returned. Fails if the Checks that a given quantity of a line item can be returned. Fails if the
item is undefined or if the returnable quantity of the item is lower, than item is undefined or if the returnable quantity of the item is lower, than
@@ -502,58 +520,14 @@ the quantity that is requested to be returned.
#### Returns #### Returns
`Object` `DeepPartial`<`LineItem`\>
a line item where the quantity is set to the requested a line item where the quantity is set to the requested
return quantity. return quantity.
| Name | Type |
| :------ | :------ |
| `adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; }...)[] |
| `allow_discounts?` | `boolean` |
| `cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: ... |
| `cart_id?` | `string` |
| `claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } |
| `claim_order_id?` | `string` |
| `created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `description?` | ``null`` \| `string` |
| `discount_total?` | ``null`` \| `number` |
| `fulfilled_quantity?` | ``null`` \| `number` |
| `gift_card_total?` | ``null`` \| `number` |
| `has_shipping?` | ``null`` \| `boolean` |
| `id?` | `string` |
| `includes_tax?` | `boolean` |
| `is_giftcard?` | `boolean` |
| `is_return?` | `boolean` |
| `metadata?` | { [x: string]: unknown; } |
| `order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } |
| `order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 50 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } |
| `order_edit_id?` | ``null`` \| `string` |
| `order_id?` | ``null`` \| `string` |
| `original_item_id?` | ``null`` \| `string` |
| `original_tax_total?` | ``null`` \| `number` |
| `original_total?` | ``null`` \| `number` |
| `quantity?` | `number` |
| `refundable?` | ``null`` \| `number` |
| `returned_quantity?` | ``null`` \| `number` |
| `shipped_quantity?` | ``null`` \| `number` |
| `should_merge?` | `boolean` |
| `subtotal?` | ``null`` \| `number` |
| `swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } |
| `swap_id?` | `string` |
| `tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] |
| `tax_total?` | ``null`` \| `number` |
| `thumbnail?` | ``null`` \| `string` |
| `title?` | `string` |
| `total?` | ``null`` \| `number` |
| `unit_price?` | `number` |
| `updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } |
| `variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 30 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 23 more ...; updated\_at?: { ...; } \| undefined; } |
| `variant_id?` | ``null`` \| `string` |
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:220](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L220) [medusa/src/services/return.ts:217](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L217)
___ ___
@@ -581,7 +555,7 @@ when statuses are not sufficient for returns.
#### Defined in #### Defined in
[packages/medusa/src/services/return.ts:190](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/return.ts#L190) [medusa/src/services/return.ts:187](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/return.ts#L187)
___ ___
@@ -605,4 +579,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/SalesChannelInventoryService.md
+183 -8
View File
@@ -1,5 +1,11 @@
# Class: SalesChannelInventoryService # Class: SalesChannelInventoryService
## Hierarchy
- `TransactionBaseService`
↳ **`SalesChannelInventoryService`**
## Constructors ## Constructors
### constructor ### constructor
@@ -12,19 +18,65 @@
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `__namedParameters` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:21](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-inventory.ts#L21) [medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-inventory.ts#L18)
## Properties ## Properties
### eventBusService\_ ### \_\_configModule\_\_
• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md) • `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-inventory.ts#L18) utils/dist/common/transaction-base-service.d.ts:5
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:4
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:6
___
### eventBusService\_
• `Protected` `Readonly` **eventBusService\_**: `IEventBusService`
#### Defined in
[medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-inventory.ts#L15)
___ ___
@@ -34,7 +86,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-inventory.ts#L19) [medusa/src/services/sales-channel-inventory.ts:16](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-inventory.ts#L16)
___ ___
@@ -42,9 +94,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Inherited from
TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-inventory.ts#L15) utils/dist/common/transaction-base-service.d.ts:7
___ ___
@@ -54,10 +110,81 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:17](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-inventory.ts#L17) [medusa/src/services/sales-channel-inventory.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-inventory.ts#L14)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:8
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:9
## Methods ## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:24
___
### retrieveAvailableItemQuantity ### retrieveAvailableItemQuantity
▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `inventoryItemId`): `Promise`<`number`\> ▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `inventoryItemId`): `Promise`<`number`\>
@@ -79,4 +206,52 @@ available quantity of item across all sales channel locations
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-inventory.ts:39](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-inventory.ts#L39) [medusa/src/services/sales-channel-inventory.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-inventory.ts#L37)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
utils/dist/common/transaction-base-service.d.ts:12
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`SalesChannelInventoryService`](SalesChannelInventoryService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`SalesChannelInventoryService`](SalesChannelInventoryService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
utils/dist/common/transaction-base-service.d.ts:11
docs/content/references/services/classes/SalesChannelLocationService.md
+66 -24
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L26) [medusa/src/services/sales-channel-location.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L25)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,17 +68,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### eventBusService ### eventBusService\_
• `Protected` `Readonly` **eventBusService**: [`EventBusService`](EventBusService.md) • `Protected` `Readonly` **eventBusService\_**: `IEventBusService`
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L23) [medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L22)
___ ___
@@ -86,13 +86,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L19) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -102,17 +102,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L22) [medusa/src/services/sales-channel-location.ts:21](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L21)
___ ___
### stockLocationService ### stockLocationService\_
• `Protected` `Readonly` **stockLocationService**: `IStockLocationService` • `Protected` `Readonly` **stockLocationService\_**: `IStockLocationService`
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L24) [medusa/src/services/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L23)
___ ___
@@ -120,13 +120,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -151,7 +169,7 @@ A promise that resolves when the association has been created.
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:77](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L77) [medusa/src/services/sales-channel-location.ts:73](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L73)
___ ___
@@ -190,13 +208,13 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
### listLocations ### listLocationIds
▸ **listLocations**(`salesChannelId`): `Promise`<`string`[]\> ▸ **listLocationIds**(`salesChannelId`): `Promise`<`string`[]\>
Lists the stock locations associated with a sales channel. Lists the stock locations associated with a sales channel.
@@ -204,7 +222,7 @@ Lists the stock locations associated with a sales channel.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `salesChannelId` | `string` | The ID of the sales channel. | | `salesChannelId` | `string` \| `string`[] | The ID of the sales channel. |
#### Returns #### Returns
@@ -214,7 +232,31 @@ A promise that resolves with an array of location IDs.
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:104](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L104) [medusa/src/services/sales-channel-location.ts:102](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L102)
___
### listSalesChannelIds
▸ **listSalesChannelIds**(`locationId`): `Promise`<`string`[]\>
Lists the sales channels associated with a stock location.
#### Parameters
| Name | Type |
| :------ | :------ |
| `locationId` | `string` |
#### Returns
`Promise`<`string`[]\>
A promise that resolves with an array of sales channel IDs.
#### Defined in
[medusa/src/services/sales-channel-location.ts:131](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L131)
___ ___
@@ -239,7 +281,7 @@ A promise that resolves when the association has been removed.
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel-location.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel-location.ts#L47) [medusa/src/services/sales-channel-location.ts:44](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel-location.ts#L44)
___ ___
@@ -263,7 +305,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -287,4 +329,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/SalesChannelService.md
+45 -41
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L37) [medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L34)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L34) [medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L31)
___ ___
@@ -84,23 +84,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L30) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### salesChannelRepository\_ ### salesChannelRepository\_
• `Protected` `Readonly` **salesChannelRepository\_**: typeof `SalesChannelRepository` • `Protected` `Readonly` **salesChannelRepository\_**: `Repository`<`SalesChannel`\> & { `addProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `ExtendedFindConfig`<`SalesChannel`\>) => `Promise`<[`SalesChannel`[], `number`]\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L33) [medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L30)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L35) [medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L32)
___ ___
@@ -118,13 +118,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -142,7 +142,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L24) [medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L24)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -167,7 +185,7 @@ the sales channel on which the products have been added
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:344](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L344) [medusa/src/services/sales-channel.ts:332](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L332)
___ ___
@@ -206,7 +224,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -233,7 +251,7 @@ the created channel
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:180](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L180) [medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L168)
___ ___
@@ -251,7 +269,7 @@ the sales channel
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:270](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L270) [medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L258)
___ ___
@@ -275,21 +293,7 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:231](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L231) [medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L219)
___
### getManager
▸ `Private` **getManager**(): `EntityManager`
#### Returns
`EntityManager`
#### Defined in
[packages/medusa/src/services/sales-channel.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L52)
___ ___
@@ -317,7 +321,7 @@ an array containing the sales channels as
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:145](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L145) [medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L134)
___ ___
@@ -342,7 +346,7 @@ the sales channel on which the products have been removed
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:323](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L323) [medusa/src/services/sales-channel.ts:311](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L311)
___ ___
@@ -367,7 +371,7 @@ a sales channel
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:103](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L103) [medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L92)
___ ___
@@ -392,7 +396,7 @@ a sales channel with matching name
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:124](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L124) [medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L113)
___ ___
@@ -410,7 +414,7 @@ the sales channel
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:300](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L300) [medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L288)
___ ___
@@ -435,7 +439,7 @@ a single SC matching the query or throws
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L63) [medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L54)
___ ___
@@ -459,7 +463,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -480,7 +484,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/sales-channel.ts:197](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L197) [medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L185)
___ ___
@@ -504,4 +508,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/SearchService.md
+13 -170
View File
@@ -25,52 +25,10 @@ AbstractSearchService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L18) [medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L16)
## Properties ## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
AbstractSearchService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
AbstractSearchService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
AbstractSearchService.\_\_moduleDeclaration\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
___
### isDefault ### isDefault
• **isDefault**: `boolean` = `true` • **isDefault**: `boolean` = `true`
@@ -81,7 +39,7 @@ AbstractSearchService.isDefault
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L11) [medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L11)
___ ___
@@ -91,21 +49,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L15) [medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L13)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
AbstractSearchService.manager\_
#### Defined in
[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L13)
___ ___
@@ -119,21 +63,7 @@ AbstractSearchService.options\_
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L16) [medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L14)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
AbstractSearchService.transactionManager\_
#### Defined in
[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L14)
## Accessors ## Accessors
@@ -151,7 +81,7 @@ AbstractSearchService.options
#### Defined in #### Defined in
[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/search-service.ts#L82) utils/dist/search/abstract-service.d.ts:5
## Methods ## Methods
@@ -177,46 +107,7 @@ AbstractSearchService.addDocuments
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L43) [medusa/src/services/search.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L40)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
AbstractSearchService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
___ ___
@@ -241,7 +132,7 @@ AbstractSearchService.createIndex
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L31) [medusa/src/services/search.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L28)
___ ___
@@ -265,7 +156,7 @@ AbstractSearchService.deleteAllDocuments
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L72) [medusa/src/services/search.ts:69](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L69)
___ ___
@@ -290,7 +181,7 @@ AbstractSearchService.deleteDocument
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L63) [medusa/src/services/search.ts:60](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L60)
___ ___
@@ -314,7 +205,7 @@ AbstractSearchService.getIndex
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L37) [medusa/src/services/search.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L34)
___ ___
@@ -340,7 +231,7 @@ AbstractSearchService.replaceDocuments
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L53) [medusa/src/services/search.ts:50](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L50)
___ ___
@@ -366,31 +257,7 @@ AbstractSearchService.search
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L78) [medusa/src/services/search.ts:75](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L75)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
AbstractSearchService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
___ ___
@@ -415,28 +282,4 @@ AbstractSearchService.updateSettings
#### Defined in #### Defined in
[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/search.ts#L89) [medusa/src/services/search.ts:86](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/search.ts#L86)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`SearchService`](SearchService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`SearchService`](SearchService.md)
#### Inherited from
AbstractSearchService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
docs/content/references/services/classes/ShippingOptionService.md
+57 -41
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L55) [medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L52)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L50) [medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L50)
___ ___
@@ -86,33 +86,33 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L52) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### methodRepository\_ ### methodRepository\_
• `Protected` `Readonly` **methodRepository\_**: typeof `ShippingMethodRepository` • `Protected` `Readonly` **methodRepository\_**: `Repository`<`ShippingMethod`\>
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L49) [medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L49)
___ ___
### optionRepository\_ ### optionRepository\_
• `Protected` `Readonly` **optionRepository\_**: typeof `ShippingOptionRepository` • `Protected` `Readonly` **optionRepository\_**: `Repository`<`ShippingOption`\> & { `upsertShippingProfile`: (`shippingOptionIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<`ShippingOption`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L48) [medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L48)
___ ___
@@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L44) [medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L44)
___ ___
@@ -132,17 +132,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L45) [medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L45)
___ ___
### requirementRepository\_ ### requirementRepository\_
• `Protected` `Readonly` **requirementRepository\_**: typeof `ShippingOptionRequirementRepository` • `Protected` `Readonly` **requirementRepository\_**: `Repository`<`ShippingOptionRequirement`\>
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L47) [medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L47)
___ ___
@@ -150,13 +150,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L53) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -182,7 +200,7 @@ the result of update
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:713](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L713) [medusa/src/services/shipping-option.ts:693](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L693)
___ ___
@@ -221,7 +239,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -247,7 +265,7 @@ the result of the create operation
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:451](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L451) [medusa/src/services/shipping-option.ts:431](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L431)
___ ___
@@ -273,7 +291,7 @@ the resulting shipping method.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:278](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L278) [medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L258)
___ ___
@@ -297,7 +315,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:691](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L691) [medusa/src/services/shipping-option.ts:671](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L671)
___ ___
@@ -321,7 +339,7 @@ removed shipping methods
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L258) [medusa/src/services/shipping-option.ts:238](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L238)
___ ___
@@ -339,7 +357,7 @@ price type "calculated".
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `option` | `ShippingOption` | the shipping option to retrieve the price for. | | `option` | `ShippingOption` | the shipping option to retrieve the price for. |
| `data` | `Record`<`string`, `unknown`\> | the shipping data to retrieve the price. | | `data` | `Record`<`string`, `unknown`\> | the shipping data to retrieve the price. |
| `cart` | `undefined` \| `Cart` \| `Order` | the context in which the price should be retrieved. | | `cart` | `undefined` \| `Order` \| `Cart` | the context in which the price should be retrieved. |
#### Returns #### Returns
@@ -349,7 +367,7 @@ the price of the shipping option.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:791](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L791) [medusa/src/services/shipping-option.ts:771](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L771)
___ ___
@@ -372,7 +390,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:148](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L148) [medusa/src/services/shipping-option.ts:145](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L145)
___ ___
@@ -395,7 +413,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L164) [medusa/src/services/shipping-option.ts:160](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L160)
___ ___
@@ -419,7 +437,7 @@ the result of update
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:742](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L742) [medusa/src/services/shipping-option.ts:722](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L722)
___ ___
@@ -435,9 +453,7 @@ Throws in case of DB Error and if profile was not found.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `optionId` | `any` | the id of the profile to get. | | `optionId` | `any` | the id of the profile to get. |
| `options` | `Object` | the options to get a profile | | `options` | `FindConfig`<`ShippingOption`\> | the options to get a profile |
| `options.relations?` | `string`[] | - |
| `options.select?` | keyof `ShippingOption`[] | - |
#### Returns #### Returns
@@ -447,7 +463,7 @@ the profile document.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:182](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L182) [medusa/src/services/shipping-option.ts:177](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L177)
___ ___
@@ -471,7 +487,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -498,7 +514,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:579](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L579) [medusa/src/services/shipping-option.ts:559](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L559)
___ ___
@@ -524,7 +540,7 @@ the resulting shipping method
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:229](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L229) [medusa/src/services/shipping-option.ts:211](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L211)
___ ___
@@ -547,7 +563,7 @@ updated shipping options
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:767](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L767) [medusa/src/services/shipping-option.ts:747](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L747)
___ ___
@@ -568,7 +584,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:408](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L408) [medusa/src/services/shipping-option.ts:388](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L388)
___ ___
@@ -595,7 +611,7 @@ the validated shipping option
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:366](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L366) [medusa/src/services/shipping-option.ts:346](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L346)
___ ___
@@ -620,7 +636,7 @@ the validated price
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:539](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L539) [medusa/src/services/shipping-option.ts:519](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L519)
___ ___
@@ -645,7 +661,7 @@ a validated shipping requirement
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-option.ts:82](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-option.ts#L82) [medusa/src/services/shipping-option.ts:77](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-option.ts#L77)
___ ___
@@ -669,4 +685,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/ShippingProfileService.md
+54 -36
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L48) [medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L45)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L40) [medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L40)
___ ___
@@ -88,23 +88,23 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L45) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: typeof `ProductRepository` • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findAndCount`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<[`Product`[], `number`]\> ; `findOne`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>) => `Promise`<``null`` \| `Product`\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `prepareQueryBuilder_`: (`options`: `ExtendedFindConfig`<`Product` & `ProductFilterOptions`\>, `q?`: `string`) => `Promise`<`SelectQueryBuilder`<`Product`\>\> ; `upsertShippingProfile`: (`productIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L43) [medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L43)
___ ___
@@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L38) [medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L38)
___ ___
@@ -124,17 +124,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L39) [medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L39)
___ ___
### shippingProfileRepository\_ ### shippingProfileRepository\_
• `Protected` `Readonly` **shippingProfileRepository\_**: typeof `ShippingProfileRepository` • `Protected` `Readonly` **shippingProfileRepository\_**: `Repository`<`ShippingProfile`\>
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L42) [medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L42)
___ ___
@@ -142,13 +142,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L46) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -173,7 +191,7 @@ the result of update
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:356](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L356) [medusa/src/services/shipping-profile.ts:355](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L355)
___ ___
@@ -199,7 +217,7 @@ the result of the model update operation
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:386](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L386) [medusa/src/services/shipping-profile.ts:385](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L385)
___ ___
@@ -238,7 +256,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -262,7 +280,7 @@ the result of the create operation
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:250](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L250) [medusa/src/services/shipping-profile.ts:249](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L249)
___ ___
@@ -280,7 +298,7 @@ the shipping profile
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:180](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L180) [medusa/src/services/shipping-profile.ts:179](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L179)
___ ___
@@ -299,7 +317,7 @@ the shipping profile
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:224](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L224) [medusa/src/services/shipping-profile.ts:223](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L223)
___ ___
@@ -323,7 +341,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:331](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L331) [medusa/src/services/shipping-profile.ts:330](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L330)
___ ___
@@ -348,7 +366,7 @@ a list of the available shipping options
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:416](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L416) [medusa/src/services/shipping-profile.ts:415](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L415)
___ ___
@@ -369,7 +387,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:83](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L83) [medusa/src/services/shipping-profile.ts:82](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L82)
___ ___
@@ -393,7 +411,7 @@ a list of product ids
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:482](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L482) [medusa/src/services/shipping-profile.ts:481](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L481)
___ ___
@@ -416,7 +434,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:71](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L71) [medusa/src/services/shipping-profile.ts:67](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L67)
___ ___
@@ -442,39 +460,39 @@ the profile document.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:135](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L135) [medusa/src/services/shipping-profile.ts:134](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L134)
___ ___
### retrieveDefault ### retrieveDefault
▸ **retrieveDefault**(): `Promise`<`undefined` \| `ShippingProfile`\> ▸ **retrieveDefault**(): `Promise`<``null`` \| `ShippingProfile`\>
#### Returns #### Returns
`Promise`<`undefined` \| `ShippingProfile`\> `Promise`<``null`` \| `ShippingProfile`\>
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:164](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L164) [medusa/src/services/shipping-profile.ts:163](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L163)
___ ___
### retrieveGiftCardDefault ### retrieveGiftCardDefault
▸ **retrieveGiftCardDefault**(): `Promise`<`undefined` \| `ShippingProfile`\> ▸ **retrieveGiftCardDefault**(): `Promise`<``null`` \| `ShippingProfile`\>
Retrieves the default gift card profile Retrieves the default gift card profile
#### Returns #### Returns
`Promise`<`undefined` \| `ShippingProfile`\> `Promise`<``null`` \| `ShippingProfile`\>
the shipping profile for gift cards the shipping profile for gift cards
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:207](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L207) [medusa/src/services/shipping-profile.ts:206](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L206)
___ ___
@@ -498,7 +516,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -525,7 +543,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/shipping-profile.ts:285](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/shipping-profile.ts#L285) [medusa/src/services/shipping-profile.ts:284](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/shipping-profile.ts#L284)
___ ___
@@ -549,4 +567,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/StagedJobService.md
+274
View File
@@ -0,0 +1,274 @@
# Class: StagedJobService
Provides layer to manipulate users.
## Hierarchy
- `TransactionBaseService`
↳ **`StagedJobService`**
## Constructors
### constructor
• **new StagedJobService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `StagedJobServiceProps` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[medusa/src/services/staged-job.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/staged-job.ts#L22)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Inherited from
TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### stagedJobRepository\_
• `Protected` **stagedJobRepository\_**: `Repository`<`StagedJob`\> & { `insertBulk`: (`jobToCreates`: `_QueryDeepPartialEntity`<`StagedJob`\>[]) => `Promise`<`StagedJob`[]\> }
#### Defined in
[medusa/src/services/staged-job.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/staged-job.ts#L20)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### create
▸ **create**(`data`): `Promise`<`StagedJob`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `EmitData`<`unknown`\> \| `EmitData`<`unknown`\>[] |
#### Returns
`Promise`<`StagedJob`[]\>
#### Defined in
[medusa/src/services/staged-job.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/staged-job.ts#L45)
___
### delete
▸ **delete**(`stagedJobIds`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `stagedJobIds` | `string` \| `string`[] |
#### Returns
`Promise`<`void`\>
#### Defined in
[medusa/src/services/staged-job.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/staged-job.ts#L37)
___
### list
▸ **list**(`config`): `Promise`<`StagedJob`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `config` | `FindConfig`<`StagedJob`\> |
#### Returns
`Promise`<`StagedJob`[]\>
#### Defined in
[medusa/src/services/staged-job.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/staged-job.ts#L29)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`StagedJobService`](StagedJobService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`StagedJobService`](StagedJobService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/StoreService.md
+41 -23
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L31) [medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L28)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,17 +68,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### currencyRepository\_ ### currencyRepository\_
• `Protected` `Readonly` **currencyRepository\_**: typeof `CurrencyRepository` • `Protected` `Readonly` **currencyRepository\_**: `Repository`<`Currency`\>
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L28) [medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L25)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L29) [medusa/src/services/store.ts:26](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L26)
___ ___
@@ -96,37 +96,55 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L24) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### storeRepository\_ ### storeRepository\_
• `Protected` `Readonly` **storeRepository\_**: typeof `StoreRepository` • `Protected` `Readonly` **storeRepository\_**: `Repository`<`Store`\>
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L27) [medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L24)
___ ___
### transactionManager\_ ### transactionManager\_
• `Protected` **transactionManager\_**: `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L25) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -150,7 +168,7 @@ result after update
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:204](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L204) [medusa/src/services/store.ts:208](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L208)
___ ___
@@ -189,7 +207,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -207,7 +225,7 @@ The store.
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L49) [medusa/src/services/store.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L45)
___ ___
@@ -227,7 +245,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:98](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L98) [medusa/src/services/store.ts:100](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L100)
___ ___
@@ -251,7 +269,7 @@ result after update
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:248](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L248) [medusa/src/services/store.ts:252](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L252)
___ ___
@@ -275,7 +293,7 @@ the store
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:85](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L85) [medusa/src/services/store.ts:83](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L83)
___ ___
@@ -299,7 +317,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -323,7 +341,7 @@ resolves to the update result.
#### Defined in #### Defined in
[packages/medusa/src/services/store.ts:114](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/store.ts#L114) [medusa/src/services/store.ts:116](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/store.ts#L116)
___ ___
@@ -347,4 +365,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/StrategyResolverService.md
+31 -13
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/strategy-resolver.ts#L14) [medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/strategy-resolver.ts#L11)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/strategy-resolver.ts#L14) [medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/strategy-resolver.ts#L11)
___ ___
@@ -84,13 +84,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/strategy-resolver.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -98,13 +98,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/strategy-resolver.ts#L12) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -143,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -163,7 +181,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/strategy-resolver.ts#L19) [medusa/src/services/strategy-resolver.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/strategy-resolver.ts#L15)
___ ___
@@ -187,7 +205,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -211,4 +229,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/SwapService.md
+61 -42
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:96](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L96) [medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L92)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L82) [medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L78)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:92](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L92) [medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L88)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L83) [medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L79)
___ ___
@@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L88) [medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L84)
___ ___
@@ -118,7 +118,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L91) [medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L87)
___ ___
@@ -128,7 +128,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L87) [medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L83)
___ ___
@@ -136,13 +136,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L77) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L84) [medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L80)
___ ___
@@ -162,7 +162,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L90) [medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L86)
___ ___
@@ -172,7 +172,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:94](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L94) [medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L90)
___ ___
@@ -182,7 +182,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L85) [medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L81)
___ ___
@@ -192,17 +192,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L89) [medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L85)
___ ___
### swapRepository\_ ### swapRepository\_
• `Protected` `Readonly` **swapRepository\_**: typeof `SwapRepository` • `Protected` `Readonly` **swapRepository\_**: `Repository`<`Swap`\>
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L80) [medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L76)
___ ___
@@ -212,7 +212,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L86) [medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L82)
___ ___
@@ -220,13 +220,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L78) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -250,7 +250,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L65) [medusa/src/services/swap.ts:64](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L64)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -270,7 +288,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:1226](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1226) [medusa/src/services/swap.ts:1219](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1219)
___ ___
@@ -309,7 +327,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -335,7 +353,7 @@ the canceled swap.
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:842](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L842) [medusa/src/services/swap.ts:837](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L837)
___ ___
@@ -359,7 +377,7 @@ updated swap
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:1043](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1043) [medusa/src/services/swap.ts:1038](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1038)
___ ___
@@ -383,6 +401,7 @@ and an optional return shipping method.
| `custom` | `Object` | contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order | | `custom` | `Object` | contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order |
| `custom.allow_backorder?` | `boolean` | - | | `custom.allow_backorder?` | `boolean` | - |
| `custom.idempotency_key?` | `string` | - | | `custom.idempotency_key?` | `string` | - |
| `custom.location_id?` | `string` | - |
| `custom.no_notification?` | `boolean` | - | | `custom.no_notification?` | `boolean` | - |
#### Returns #### Returns
@@ -393,7 +412,7 @@ the newly created swap
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:317](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L317) [medusa/src/services/swap.ts:302](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L302)
___ ___
@@ -421,7 +440,7 @@ the swap with its cart_id prop set to the id of the new cart.
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:571](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L571) [medusa/src/services/swap.ts:558](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L558)
___ ___
@@ -447,7 +466,7 @@ the updated swap with new status and fulfillments.
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:904](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L904) [medusa/src/services/swap.ts:899](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L899)
___ ___
@@ -474,7 +493,7 @@ the updated swap with new fulfillments and status.
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:1074](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1074) [medusa/src/services/swap.ts:1069](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1069)
___ ___
@@ -499,7 +518,7 @@ resolves to the updated result.
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:1152](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1152) [medusa/src/services/swap.ts:1147](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1147)
___ ___
@@ -524,7 +543,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:287](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L287) [medusa/src/services/swap.ts:274](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L274)
___ ___
@@ -548,7 +567,7 @@ processed swap
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:415](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L415) [medusa/src/services/swap.ts:402](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L402)
___ ___
@@ -572,7 +591,7 @@ swap related to the cart
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:709](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L709) [medusa/src/services/swap.ts:704](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L704)
___ ___
@@ -597,7 +616,7 @@ the resulting order
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:1192](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L1192) [medusa/src/services/swap.ts:1185](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L1185)
___ ___
@@ -622,7 +641,7 @@ the swap
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:211](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L211) [medusa/src/services/swap.ts:204](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L204)
___ ___
@@ -647,7 +666,7 @@ the swap
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:260](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L260) [medusa/src/services/swap.ts:247](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L247)
___ ___
@@ -671,7 +690,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -695,7 +714,7 @@ transformed find swap config
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:138](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L138) [medusa/src/services/swap.ts:131](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L131)
___ ___
@@ -720,7 +739,7 @@ updated swap record
#### Defined in #### Defined in
[packages/medusa/src/services/swap.ts:538](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/swap.ts#L538) [medusa/src/services/swap.ts:525](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/swap.ts#L525)
___ ___
@@ -744,4 +763,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/SystemPaymentProviderService.md
+40 -22
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L10) [medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L6)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -74,13 +74,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -88,13 +88,13 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -104,7 +104,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L8) [medusa/src/services/system-payment-provider.ts:4](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L4)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -143,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -163,7 +181,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L26) [medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L22)
___ ___
@@ -183,7 +201,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L50) [medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L46)
___ ___
@@ -203,7 +221,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L42) [medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L38)
___ ___
@@ -223,7 +241,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L14) [medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L10)
___ ___
@@ -243,7 +261,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L38) [medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L34)
___ ___
@@ -263,7 +281,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L22) [medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L18)
___ ___
@@ -283,7 +301,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L18) [medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L14)
___ ___
@@ -303,7 +321,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L46) [medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L42)
___ ___
@@ -327,7 +345,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -347,7 +365,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L34) [medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L30)
___ ___
@@ -367,7 +385,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/system-payment-provider.ts#L30) [medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/system-payment-provider.ts#L26)
___ ___
@@ -391,4 +409,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/TaxProviderService.md
+54 -36
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L51) [medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L45)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L44) [medusa/src/services/tax-provider.ts:38](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L38)
___ ___
@@ -88,17 +88,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L43) [medusa/src/services/tax-provider.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L37)
___ ___
### eventBus\_ ### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md) • `Protected` `Readonly` **eventBus\_**: `IEventBusService`
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L49) [medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L43)
___ ___
@@ -106,43 +106,43 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L40) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### smTaxLineRepo\_ ### smTaxLineRepo\_
• `Protected` `Readonly` **smTaxLineRepo\_**: typeof `ShippingMethodTaxLineRepository` • `Protected` `Readonly` **smTaxLineRepo\_**: `Repository`<`ShippingMethodTaxLine`\> & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: `ShippingMethodTaxLine`[]) => `Promise`<`ShippingMethodTaxLine`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L47) [medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L41)
___ ___
### taxLineRepo\_ ### taxLineRepo\_
• `Protected` `Readonly` **taxLineRepo\_**: typeof `LineItemTaxLineRepository` • `Protected` `Readonly` **taxLineRepo\_**: `Repository`<`LineItemTaxLine`\> & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: `LineItemTaxLine`[]) => `Promise`<`LineItemTaxLine`[]\> }
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L46) [medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L40)
___ ___
### taxProviderRepo\_ ### taxProviderRepo\_
• `Protected` `Readonly` **taxProviderRepo\_**: typeof `TaxProviderRepository` • `Protected` `Readonly` **taxProviderRepo\_**: `Repository`<`TaxProvider`\>
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L48) [medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L42)
___ ___
@@ -152,21 +152,39 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L45) [medusa/src/services/tax-provider.ts:39](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L39)
___ ___
### transactionManager\_ ### transactionManager\_
• `Protected` **transactionManager\_**: `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L41) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -205,7 +223,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -225,7 +243,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L97) [medusa/src/services/tax-provider.ts:89](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L89)
___ ___
@@ -245,7 +263,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:107](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L107) [medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L97)
___ ___
@@ -271,7 +289,7 @@ the newly created tax lines
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:183](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L183) [medusa/src/services/tax-provider.ts:171](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L171)
___ ___
@@ -296,7 +314,7 @@ the newly created tax lines
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:129](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L129) [medusa/src/services/tax-provider.ts:117](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L117)
___ ___
@@ -321,7 +339,7 @@ the cache key to use for the id set
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:484](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L484) [medusa/src/services/tax-provider.ts:476](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L476)
___ ___
@@ -347,7 +365,7 @@ the tax rates configured for the shipping option.
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:436](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L436) [medusa/src/services/tax-provider.ts:428](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L428)
___ ___
@@ -373,7 +391,7 @@ the tax rates configured for the shipping option.
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:389](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L389) [medusa/src/services/tax-provider.ts:381](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L381)
___ ___
@@ -400,7 +418,7 @@ the computed tax lines
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:204](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L204) [medusa/src/services/tax-provider.ts:192](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L192)
___ ___
@@ -429,7 +447,7 @@ the computed tax lines
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:256](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L256) [medusa/src/services/tax-provider.ts:246](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L246)
___ ___
@@ -452,7 +470,7 @@ Return a map of tax lines for line items and shipping methods
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:352](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L352) [medusa/src/services/tax-provider.ts:344](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L344)
___ ___
@@ -466,7 +484,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:65](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L65) [medusa/src/services/tax-provider.ts:57](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L57)
___ ___
@@ -486,7 +504,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:488](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L488) [medusa/src/services/tax-provider.ts:480](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L480)
___ ___
@@ -510,7 +528,7 @@ the region specific tax provider
#### Defined in #### Defined in
[packages/medusa/src/services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-provider.ts#L75) [medusa/src/services/tax-provider.ts:67](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-provider.ts#L67)
___ ___
@@ -534,7 +552,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -558,4 +576,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/TaxRateService.md
+48 -30
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:33](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L33) [medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L29)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -74,13 +74,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L25) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -90,7 +90,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L28) [medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L24)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L29) [medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L25)
___ ___
@@ -110,17 +110,17 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L30) [medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L26)
___ ___
### taxRateRepository\_ ### taxRateRepository\_
• `Protected` `Readonly` **taxRateRepository\_**: typeof `TaxRateRepository` • `Protected` `Readonly` **taxRateRepository\_**: `Repository`<`TaxRate`\> & { `addToProduct`: (`id`: `string`, `productIds`: `string`[], `overrideExisting`: `boolean`) => `Promise`<`ProductTaxRate`[]\> ; `addToProductType`: (`id`: `string`, `productTypeIds`: `string`[], `overrideExisting`: `boolean`) => `Promise`<`ProductTypeTaxRate`[]\> ; `addToShippingOption`: (`id`: `string`, `optionIds`: `string`[], `overrideExisting`: `boolean`) => `Promise`<`ShippingTaxRate`[]\> ; `applyResolutionsToQueryBuilder`: (`qb`: `SelectQueryBuilder`<`TaxRate`\>, `resolverFields`: `string`[]) => `SelectQueryBuilder`<`TaxRate`\> ; `findAndCountWithResolution`: (`findOptions`: `FindManyOptions`<`TaxRate`\>) => `Promise`<[`TaxRate`[], `number`]\> ; `findOneWithResolution`: (`findOptions`: `FindManyOptions`<`TaxRate`\>) => `Promise`<``null`` \| `TaxRate`\> ; `findWithResolution`: (`findOptions`: `FindManyOptions`<`TaxRate`\>) => `Promise`<`TaxRate`[]\> ; `getFindQueryBuilder`: (`findOptions`: `FindManyOptions`<`TaxRate`\>) => `SelectQueryBuilder`<`TaxRate`\> ; `listByProduct`: (`productId`: `string`, `config`: `TaxRateListByConfig`) => `Promise`<`TaxRate`[]\> ; `listByShippingOption`: (`optionId`: `string`) => `Promise`<`TaxRate`[]\> ; `removeFromProduct`: (`id`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> ; `removeFromProductType`: (`id`: `string`, `productTypeIds`: `string`[]) => `Promise`<`DeleteResult`\> ; `removeFromShippingOption`: (`id`: `string`, `optionIds`: `string`[]) => `Promise`<`DeleteResult`\> }
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L31) [medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L27)
___ ___
@@ -128,13 +128,31 @@ ___
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L26) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -156,7 +174,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L190) [medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L190)
___ ___
@@ -178,7 +196,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L226) [medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L226)
___ ___
@@ -200,7 +218,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L266) [medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L266)
___ ___
@@ -239,7 +257,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -259,7 +277,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:97](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L97) [medusa/src/services/tax-rate.ts:93](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L93)
___ ___
@@ -279,7 +297,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:128](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L128) [medusa/src/services/tax-rate.ts:124](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L124)
___ ___
@@ -300,7 +318,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:49](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L49) [medusa/src/services/tax-rate.ts:44](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L44)
___ ___
@@ -321,7 +339,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:60](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L60) [medusa/src/services/tax-rate.ts:55](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L55)
___ ___
@@ -342,7 +360,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L314) [medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L314)
___ ___
@@ -362,7 +380,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:324](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L324) [medusa/src/services/tax-rate.ts:325](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L325)
___ ___
@@ -383,7 +401,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L136) [medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L136)
___ ___
@@ -404,7 +422,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L154) [medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L154)
___ ___
@@ -425,7 +443,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L172) [medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L172)
___ ___
@@ -446,7 +464,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:71](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L71) [medusa/src/services/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L66)
___ ___
@@ -470,7 +488,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -491,7 +509,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/tax-rate.ts:113](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/tax-rate.ts#L113) [medusa/src/services/tax-rate.ts:109](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/tax-rate.ts#L109)
___ ___
@@ -515,4 +533,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/TokenService.md
+5 -5
View File
@@ -14,7 +14,7 @@
#### Defined in #### Defined in
[packages/medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/token.ts#L16) [medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/token.ts#L16)
## Properties ## Properties
@@ -24,7 +24,7 @@
#### Defined in #### Defined in
[packages/medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/token.ts#L14) [medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/token.ts#L14)
___ ___
@@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/token.ts#L12) [medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/token.ts#L12)
## Methods ## Methods
@@ -55,7 +55,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/token.ts#L34) [medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/token.ts#L34)
___ ___
@@ -76,4 +76,4 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/token.ts#L20) [medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/token.ts#L20)
docs/content/references/services/classes/TotalsService.md
+69 -51
View File
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:113](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L113) [medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L112)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:111](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L111) [medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L110)
___ ___
@@ -88,13 +88,13 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L105) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L109) [medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L108)
___ ___
@@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L110) [medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L109)
___ ___
@@ -124,21 +124,39 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L108) [medusa/src/services/totals.ts:107](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L107)
___ ___
### transactionManager\_ ### transactionManager\_
• `Protected` **transactionManager\_**: `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L106) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -177,7 +195,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -205,7 +223,7 @@ triples of lineitem, variant and applied discount
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:629](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L629) [medusa/src/services/totals.ts:626](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L626)
___ ___
@@ -224,7 +242,7 @@ alongside the variant on which the discount was applied.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `discount` | `Discount` | the discount to which we do the calculation | | `discount` | `Discount` | the discount to which we do the calculation |
| `cart` | `Cart` \| `Order` | the cart to calculate discounts for | | `cart` | `Order` \| `Cart` | the cart to calculate discounts for |
#### Returns #### Returns
@@ -234,7 +252,7 @@ array of triples of lineitem, variant and applied discount
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:671](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L671) [medusa/src/services/totals.ts:668](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L668)
___ ___
@@ -265,7 +283,7 @@ the allocation map for the line items in the cart or order.
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:438](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L438) [medusa/src/services/totals.ts:435](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L435)
___ ___
@@ -290,7 +308,7 @@ the tax calculation context
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:1025](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L1025) [medusa/src/services/totals.ts:1027](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L1027)
___ ___
@@ -305,7 +323,7 @@ discount types. If discounts aren't present or invalid returns 0.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to calculate discounts for | | `cartOrOrder` | `Order` \| `Cart` | the cart or order to calculate discounts for |
#### Returns #### Returns
@@ -315,7 +333,7 @@ the total discounts amount
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L1005) [medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L1005)
___ ___
@@ -329,7 +347,7 @@ Gets the gift card amount on a cart or order.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to get gift card amount for | | `cartOrOrder` | `Order` \| `Cart` | the cart or order to get gift card amount for |
| `opts` | `Object` | - | | `opts` | `Object` | - |
| `opts.gift_cardable?` | `number` | - | | `opts.gift_cardable?` | `number` | - |
@@ -341,7 +359,7 @@ the gift card amount applied to the cart or order
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L974) [medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L974)
___ ___
@@ -356,7 +374,7 @@ cards are taxable this amount should exclude taxes.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to get gift card amount for | | `cartOrOrder` | `Order` \| `Cart` | the cart or order to get gift card amount for |
#### Returns #### Returns
@@ -366,7 +384,7 @@ the gift card amount applied to the cart or order
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L957) [medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L957)
___ ___
@@ -395,7 +413,7 @@ the allocations that the discount has on the items in the cart or
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:722](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L722) [medusa/src/services/totals.ts:719](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L719)
___ ___
@@ -407,7 +425,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | | `cartOrOrder` | `Order` \| `Cart` |
#### Returns #### Returns
@@ -415,7 +433,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:699](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L699) [medusa/src/services/totals.ts:696](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L696)
___ ___
@@ -436,7 +454,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:684](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L684) [medusa/src/services/totals.ts:681](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L681)
___ ___
@@ -461,7 +479,7 @@ the line item refund amount.
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:507](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L507) [medusa/src/services/totals.ts:504](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L504)
___ ___
@@ -477,7 +495,7 @@ taxes into account. This can be controlled through the options.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `lineItem` | `LineItem` | the line item to calculate a total for | | `lineItem` | `LineItem` | the line item to calculate a total for |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to use as context for the calculation | | `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the calculation |
| `options` | `GetLineItemTotalOptions` | the options to use for the calculation | | `options` | `GetLineItemTotalOptions` | the options to use for the calculation |
#### Returns #### Returns
@@ -488,7 +506,7 @@ the line item total
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L930) [medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L930)
___ ___
@@ -505,7 +523,7 @@ applied to a line item and the amount of tax applied to a line item.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `lineItem` | `LineItem` | the line item to calculate totals for | | `lineItem` | `LineItem` | the line item to calculate totals for |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to use as context for the calculation | | `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the calculation |
| `options` | `LineItemTotalsOptions` | the options to evaluate the line item totals for | | `options` | `LineItemTotalsOptions` | the options to evaluate the line item totals for |
#### Returns #### Returns
@@ -516,7 +534,7 @@ the breakdown of the line item totals
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:778](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L778) [medusa/src/services/totals.ts:775](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L775)
___ ___
@@ -540,7 +558,7 @@ the total paid amount
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L160) [medusa/src/services/totals.ts:157](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L157)
___ ___
@@ -567,7 +585,7 @@ the calculated subtotal
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:586](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L586) [medusa/src/services/totals.ts:583](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L583)
___ ___
@@ -591,7 +609,7 @@ the total refunded amount for an order.
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:492](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L492) [medusa/src/services/totals.ts:489](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L489)
___ ___
@@ -607,7 +625,7 @@ already provided.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `shippingMethod` | `ShippingMethod` | the shipping method to get totals breakdown for. | | `shippingMethod` | `ShippingMethod` | the shipping method to get totals breakdown for. |
| `cartOrOrder` | `Cart` \| `Order` | the cart or order to use as context for the breakdown | | `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the breakdown |
| `opts` | `GetShippingMethodTotalsOptions` | options for what should be included | | `opts` | `GetShippingMethodTotalsOptions` | options for what should be included |
#### Returns #### Returns
@@ -618,7 +636,7 @@ An object that breaks down the totals for the shipping method
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:194](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L194) [medusa/src/services/totals.ts:191](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L191)
___ ___
@@ -632,7 +650,7 @@ Calculates shipping total
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | cart or order to calculate subtotal for | | `cartOrOrder` | `Order` \| `Cart` | cart or order to calculate subtotal for |
#### Returns #### Returns
@@ -642,7 +660,7 @@ shipping total
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:322](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L322) [medusa/src/services/totals.ts:319](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L319)
___ ___
@@ -656,7 +674,7 @@ Calculates subtotal of a given cart or order.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | cart or order to calculate subtotal for | | `cartOrOrder` | `Order` \| `Cart` | cart or order to calculate subtotal for |
| `opts` | `SubtotalOptions` | options | | `opts` | `SubtotalOptions` | options |
#### Returns #### Returns
@@ -667,7 +685,7 @@ the calculated subtotal
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L286) [medusa/src/services/totals.ts:283](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L283)
___ ___
@@ -692,7 +710,7 @@ the swap total
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:175](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L175) [medusa/src/services/totals.ts:172](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L172)
___ ___
@@ -707,7 +725,7 @@ Currently based on the Danish tax system
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ | | :------ | :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | `undefined` | cart or order to calculate tax total for | | `cartOrOrder` | `Order` \| `Cart` | `undefined` | cart or order to calculate tax total for |
| `forceTaxes` | `boolean` | `false` | whether taxes should be calculated regardless of region settings | | `forceTaxes` | `boolean` | `false` | whether taxes should be calculated regardless of region settings |
#### Returns #### Returns
@@ -718,7 +736,7 @@ tax total
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:349](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L349) [medusa/src/services/totals.ts:346](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L346)
___ ___
@@ -732,7 +750,7 @@ Calculates total of a given cart or order.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrOrder` | `Cart` \| `Order` | object to calculate total for | | `cartOrOrder` | `Order` \| `Cart` | object to calculate total for |
| `options` | `GetTotalsOptions` | options to calculate by | | `options` | `GetTotalsOptions` | options to calculate by |
#### Returns #### Returns
@@ -743,7 +761,7 @@ the calculated subtotal
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:137](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L137) [medusa/src/services/totals.ts:134](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L134)
___ ___
@@ -767,7 +785,7 @@ the rounded value
#### Defined in #### Defined in
[packages/medusa/src/services/totals.ts:1055](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/totals.ts#L1055) [medusa/src/services/totals.ts:1057](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/totals.ts#L1057)
___ ___
@@ -791,7 +809,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -815,4 +833,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/classes/UserService.md
+46 -28
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:47](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L47) [medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L45)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L42) [medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L40)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:44](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L44) [medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L42)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L45) [medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L43)
___ ___
@@ -106,37 +106,37 @@ ___
• `Protected` **manager\_**: `EntityManager` • `Protected` **manager\_**: `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.manager\_ TransactionBaseService.manager\_
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L40) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### transactionManager\_ ### transactionManager\_
• `Protected` **transactionManager\_**: `EntityManager` • `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides #### Inherited from
TransactionBaseService.transactionManager\_ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L41) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
### userRepository\_ ### userRepository\_
• `Protected` `Readonly` **userRepository\_**: typeof `UserRepository` • `Protected` `Readonly` **userRepository\_**: `Repository`<`User`\>
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L43) [medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L41)
___ ___
@@ -155,7 +155,25 @@ ___
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L33) [medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L33)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -194,7 +212,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -220,7 +238,7 @@ the result of create
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:179](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L179) [medusa/src/services/user.ts:171](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L171)
___ ___
@@ -244,7 +262,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:259](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L259) [medusa/src/services/user.ts:251](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L251)
___ ___
@@ -272,7 +290,7 @@ the generated JSON web token
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:323](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L323) [medusa/src/services/user.ts:315](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L315)
___ ___
@@ -296,7 +314,7 @@ hashed password
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:167](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L167) [medusa/src/services/user.ts:159](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L159)
___ ___
@@ -319,7 +337,7 @@ the result of the find operation
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:69](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L69) [medusa/src/services/user.ts:65](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L65)
___ ___
@@ -345,7 +363,7 @@ the user document.
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:82](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L82) [medusa/src/services/user.ts:77](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L77)
___ ___
@@ -371,7 +389,7 @@ the user document.
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:113](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L113) [medusa/src/services/user.ts:107](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L107)
___ ___
@@ -397,7 +415,7 @@ the user document.
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:142](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L142) [medusa/src/services/user.ts:135](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L135)
___ ___
@@ -424,7 +442,7 @@ the result of the update operation
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:294](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L294) [medusa/src/services/user.ts:286](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L286)
___ ___
@@ -448,7 +466,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -473,7 +491,7 @@ the result of create
#### Defined in #### Defined in
[packages/medusa/src/services/user.ts:213](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/user.ts#L213) [medusa/src/services/user.ts:205](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/user.ts#L205)
___ ___
@@ -497,4 +515,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
docs/content/references/services/index.md
+1 -1
View File
@@ -5,7 +5,6 @@
- [AnalyticsConfigService](classes/AnalyticsConfigService.md) - [AnalyticsConfigService](classes/AnalyticsConfigService.md)
- [AuthService](classes/AuthService.md) - [AuthService](classes/AuthService.md)
- [BatchJobService](classes/BatchJobService.md) - [BatchJobService](classes/BatchJobService.md)
- [CacheService](classes/CacheService.md)
- [CartService](classes/CartService.md) - [CartService](classes/CartService.md)
- [ClaimItemService](classes/ClaimItemService.md) - [ClaimItemService](classes/ClaimItemService.md)
- [ClaimService](classes/ClaimService.md) - [ClaimService](classes/ClaimService.md)
@@ -51,6 +50,7 @@
- [SearchService](classes/SearchService.md) - [SearchService](classes/SearchService.md)
- [ShippingOptionService](classes/ShippingOptionService.md) - [ShippingOptionService](classes/ShippingOptionService.md)
- [ShippingProfileService](classes/ShippingProfileService.md) - [ShippingProfileService](classes/ShippingProfileService.md)
- [StagedJobService](classes/StagedJobService.md)
- [StoreService](classes/StoreService.md) - [StoreService](classes/StoreService.md)
- [StrategyResolverService](classes/StrategyResolverService.md) - [StrategyResolverService](classes/StrategyResolverService.md)
- [SwapService](classes/SwapService.md) - [SwapService](classes/SwapService.md)