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

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

Browse Source 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]shahednasserShahed Nasser
 authored and GitHub committed 2023-10-09 19:57:05 +03:00
1 parent 431782d023
commit 074055acbb
58 files changed
+1975 -1840
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/services/classes/AnalyticsConfigService.md
+18 -18
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new AnalyticsConfigService**(`__namedParameters`) • **new AnalyticsConfigService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/analytics-config.ts#L21) [medusa/src/services/analytics-config.ts:21](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/analytics-config.ts#L21)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/analytics-config.ts#L18) [medusa/src/services/analytics-config.ts:18](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/analytics-config.ts#L18)
___ ___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/analytics-config.ts#L19) [medusa/src/services/analytics-config.ts:19](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/analytics-config.ts#L19)
## Accessors ## Accessors
@@ -132,7 +132,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -194,7 +194,7 @@ Creates an analytics config.
#### Defined in #### Defined in
[medusa/src/services/analytics-config.ts:50](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/analytics-config.ts#L50) [medusa/src/services/analytics-config.ts:50](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/analytics-config.ts#L50)
___ ___
@@ -216,7 +216,7 @@ Deletes an analytics config.
#### Defined in #### Defined in
[medusa/src/services/analytics-config.ts:94](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/analytics-config.ts#L94) [medusa/src/services/analytics-config.ts:94](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/analytics-config.ts#L94)
___ ___
@@ -236,7 +236,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/analytics-config.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/analytics-config.ts#L28) [medusa/src/services/analytics-config.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/analytics-config.ts#L28)
___ ___
@@ -260,7 +260,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -283,7 +283,7 @@ Updates an analytics config. If the config does not exist, it will be created in
#### Defined in #### Defined in
[medusa/src/services/analytics-config.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/analytics-config.ts#L65) [medusa/src/services/analytics-config.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/analytics-config.ts#L65)
___ ___
@@ -307,4 +307,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/AuthService.md
+21 -21
View File
@@ -12,13 +12,13 @@ Can authenticate a user based on email password combination
### constructor ### constructor
• **new AuthService**(`__namedParameters`) • **new AuthService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/auth.ts#L22) [medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/auth.ts#L22)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/auth.ts#L20) [medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/auth.ts#L20)
___ ___
@@ -92,7 +92,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -106,7 +106,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/auth.ts#L19) [medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/auth.ts#L19)
## Accessors ## Accessors
@@ -134,7 +134,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -173,7 +173,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -196,12 +196,12 @@ scrypt to match password with hashed value.
`Promise`<`AuthenticateResult`\> `Promise`<`AuthenticateResult`\>
success: whether authentication succeeded success: whether authentication succeeded
user: the user document if authentication succeded user: the user document if authentication succeeded
error: a string with the error message error: a string with the error message
#### Defined in #### Defined in
[medusa/src/services/auth.ts:95](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/auth.ts#L95) [medusa/src/services/auth.ts:81](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/auth.ts#L81)
___ ___
@@ -222,12 +222,12 @@ Authenticates a given user with an API token
`Promise`<`AuthenticateResult`\> `Promise`<`AuthenticateResult`\>
success: whether authentication succeeded success: whether authentication succeeded
user: the user document if authentication succeded user: the user document if authentication succeeded
error: a string with the error message error: a string with the error message
#### Defined in #### Defined in
[medusa/src/services/auth.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/auth.ts#L52) [medusa/src/services/auth.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/auth.ts#L52)
___ ___
@@ -250,12 +250,12 @@ scrypt to match password with hashed value.
`Promise`<`AuthenticateResult`\> `Promise`<`AuthenticateResult`\>
success: whether authentication succeeded success: whether authentication succeeded
user: the user document if authentication succeded customer: the customer document if authentication succeded
error: a string with the error message error: a string with the error message
#### Defined in #### Defined in
[medusa/src/services/auth.ts:144](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/auth.ts#L144) [medusa/src/services/auth.ts:130](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/auth.ts#L130)
___ ___
@@ -280,7 +280,7 @@ the result of the comparison
#### Defined in #### Defined in
[medusa/src/services/auth.ts:36](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/auth.ts#L36) [medusa/src/services/auth.ts:36](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/auth.ts#L36)
___ ___
@@ -304,7 +304,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -328,4 +328,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/BatchJobService.md
+29 -29
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new BatchJobService**(`__namedParameters`) • **new BatchJobService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:91](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L91) [medusa/src/services/batch-job.ts:91](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L91)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L39) [medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L39)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L43) [medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L43)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L40) [medusa/src/services/batch-job.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L40)
___ ___
@@ -110,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L41) [medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L41)
___ ___
@@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -157,7 +157,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L28) [medusa/src/services/batch-job.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L28)
## Accessors ## Accessors
@@ -175,7 +175,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -214,7 +214,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -234,7 +234,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:270](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L270) [medusa/src/services/batch-job.ts:270](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L270)
___ ___
@@ -254,7 +254,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:252](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L252) [medusa/src/services/batch-job.ts:252](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L252)
___ ___
@@ -274,7 +274,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:234](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L234) [medusa/src/services/batch-job.ts:234](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L234)
___ ___
@@ -294,7 +294,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:144](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L144) [medusa/src/services/batch-job.ts:144](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L144)
___ ___
@@ -315,7 +315,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L132) [medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L132)
___ ___
@@ -336,7 +336,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:367](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L367) [medusa/src/services/batch-job.ts:367](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L367)
___ ___
@@ -357,7 +357,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:104](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L104) [medusa/src/services/batch-job.ts:104](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L104)
___ ___
@@ -378,7 +378,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:341](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L341) [medusa/src/services/batch-job.ts:341](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L341)
___ ___
@@ -398,7 +398,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:288](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L288) [medusa/src/services/batch-job.ts:288](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L288)
___ ___
@@ -418,7 +418,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:321](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L321) [medusa/src/services/batch-job.ts:321](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L321)
___ ___
@@ -442,7 +442,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -463,7 +463,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:161](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L161) [medusa/src/services/batch-job.ts:161](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L161)
___ ___
@@ -484,7 +484,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/batch-job.ts:200](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/batch-job.ts#L200) [medusa/src/services/batch-job.ts:200](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/batch-job.ts#L200)
___ ___
@@ -508,4 +508,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/CartService.md
+121 -101
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new CartService**(`__namedParameters`) • **new CartService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/cart.ts:134](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L134) [medusa/src/services/cart.ts:143](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L143)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L109) [medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L116)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L108) [medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L115)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L127) [medusa/src/services/cart.ts:135](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L135)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L120) [medusa/src/services/cart.ts:127](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L127)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L122) [medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L130)
___ ___
@@ -126,7 +126,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L112) [medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L119)
___ ___
@@ -136,7 +136,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:130](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L130) [medusa/src/services/cart.ts:138](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L138)
___ ___
@@ -146,7 +146,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L123) [medusa/src/services/cart.ts:131](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L131)
___ ___
@@ -156,7 +156,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L129) [medusa/src/services/cart.ts:137](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L137)
___ ___
@@ -166,7 +166,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L111) [medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L118)
___ ___
@@ -176,7 +176,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L118) [medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L125)
___ ___
@@ -190,7 +190,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -200,7 +200,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L126) [medusa/src/services/cart.ts:134](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L134)
___ ___
@@ -210,7 +210,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L119) [medusa/src/services/cart.ts:126](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L126)
___ ___
@@ -220,7 +220,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L110) [medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L117)
___ ___
@@ -230,7 +230,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L128) [medusa/src/services/cart.ts:136](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L136)
___
### pricingService\_
• `Protected` `Readonly` **pricingService\_**: [`PricingService`](PricingService.md)
#### Defined in
[medusa/src/services/cart.ts:141](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L141)
___ ___
@@ -240,7 +250,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L114) [medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L121)
___ ___
@@ -250,7 +260,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L132) [medusa/src/services/cart.ts:140](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L140)
___ ___
@@ -260,7 +270,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L113) [medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L120)
___ ___
@@ -270,7 +280,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L117) [medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L124)
___ ___
@@ -280,7 +290,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L116) [medusa/src/services/cart.ts:123](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L123)
___ ___
@@ -290,7 +300,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L107) [medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L114)
___ ___
@@ -300,7 +310,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L121) [medusa/src/services/cart.ts:128](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L128)
___
### shippingProfileService\_
• `Protected` `Readonly` **shippingProfileService\_**: [`ShippingProfileService`](ShippingProfileService.md)
#### Defined in
[medusa/src/services/cart.ts:129](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L129)
___ ___
@@ -310,7 +330,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L115) [medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L122)
___ ___
@@ -320,7 +340,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:124](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L124) [medusa/src/services/cart.ts:132](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L132)
___ ___
@@ -330,7 +350,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:125](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L125) [medusa/src/services/cart.ts:133](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L133)
___ ___
@@ -344,7 +364,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -362,7 +382,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L101) [medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L108)
## Accessors ## Accessors
@@ -380,7 +400,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -390,17 +410,13 @@ TransactionBaseService.activeManager\_
Adds a line item to the cart. Adds a line item to the cart.
**`Deprecated`**
Use [addOrUpdateLineItems](CartService.md#addorupdatelineitems) instead.
#### Parameters #### Parameters
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ | | :------ | :------ | :------ | :------ |
| `cartId` | `string` | `undefined` | the id of the cart that we will add to | | `cartId` | `string` | `undefined` | the id of the cart that we will add to |
| `lineItem` | `LineItem` | `undefined` | the line item to add. | | `lineItem` | `LineItem` | `undefined` | the line item to add. |
| `config` | `Object` | `undefined` | validateSalesChannels - should check if product belongs to the same sales chanel as cart (if cart has associated sales channel) | | `config` | `Object` | `undefined` | validateSalesChannels - should check if product belongs to the same sales channel as cart (if cart has associated sales channel) |
| `config.validateSalesChannels` | `boolean` | `true` | - | | `config.validateSalesChannels` | `boolean` | `true` | - |
#### Returns #### Returns
@@ -409,9 +425,13 @@ Use [addOrUpdateLineItems](CartService.md#addorupdatelineitems) instead.
the result of the update operation the result of the update operation
**`Deprecated`**
Use [addOrUpdateLineItems](CartService.md#addorupdatelineitems) instead.
#### Defined in #### Defined in
[medusa/src/services/cart.ts:610](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L610) [medusa/src/services/cart.ts:654](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L654)
___ ___
@@ -428,7 +448,7 @@ to have has_shipping to false. Finally, the adjustments will be updated.
| :------ | :------ | :------ | :------ | | :------ | :------ | :------ | :------ |
| `cartId` | `string` | `undefined` | the id of the cart that we will add to | | `cartId` | `string` | `undefined` | the id of the cart that we will add to |
| `lineItems` | `LineItem` \| `LineItem`[] | `undefined` | the line items to add. | | `lineItems` | `LineItem` \| `LineItem`[] | `undefined` | the line items to add. |
| `config` | `Object` | `undefined` | validateSalesChannels - should check if product belongs to the same sales chanel as cart (if cart has associated sales channel) | | `config` | `Object` | `undefined` | validateSalesChannels - should check if product belongs to the same sales channel as cart (if cart has associated sales channel) |
| `config.validateSalesChannels` | `boolean` | `true` | - | | `config.validateSalesChannels` | `boolean` | `true` | - |
#### Returns #### Returns
@@ -439,7 +459,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:741](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L741) [medusa/src/services/cart.ts:794](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L794)
___ ___
@@ -469,7 +489,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2071](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2071) [medusa/src/services/cart.ts:2179](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2179)
___ ___
@@ -497,7 +517,7 @@ void
#### Defined in #### Defined in
[medusa/src/services/cart.ts:998](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L998) [medusa/src/services/cart.ts:1113](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1113)
___ ___
@@ -523,7 +543,7 @@ Throws if discount regions does not include the cart region
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1416](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1416) [medusa/src/services/cart.ts:1524](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1524)
___ ___
@@ -549,7 +569,7 @@ Throws if discount regions does not include the cart region
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1428](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1428) [medusa/src/services/cart.ts:1536](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1536)
___ ___
@@ -570,7 +590,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1381](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1381) [medusa/src/services/cart.ts:1489](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1489)
___ ___
@@ -609,7 +629,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -628,7 +648,7 @@ set the payment on the cart.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to authorize payment for | | `cartId` | `string` | the id of the cart to authorize payment for |
| `context` | `Record`<`string`, `unknown`\> & { `cart_id`: `string` } | object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling. | | `context` | `Record`<`string`, `unknown`\> & { `cart_id`: `string` } | object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling. |
#### Returns #### Returns
@@ -638,7 +658,7 @@ the resulting cart
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1595](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1595) [medusa/src/services/cart.ts:1703](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1703)
___ ___
@@ -662,7 +682,7 @@ the result of the create operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:309](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L309) [medusa/src/services/cart.ts:352](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L352)
___ ___
@@ -686,7 +706,7 @@ the resultign customer object
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1267](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1267) [medusa/src/services/cart.ts:1375](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1375)
___ ___
@@ -706,7 +726,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2499](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2499) [medusa/src/services/cart.ts:2630](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2630)
___ ___
@@ -727,7 +747,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2551](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2551) [medusa/src/services/cart.ts:2682](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2682)
___ ___
@@ -735,10 +755,6 @@ ___
▸ `Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<`Cart`\> ▸ `Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<`Cart`\>
**`Deprecated`**
Use decorateTotals instead
#### Parameters #### Parameters
| Name | Type | | Name | Type |
@@ -751,9 +767,13 @@ Use decorateTotals instead
`Promise`<`Cart`\> `Promise`<`Cart`\>
**`Deprecated`**
Use decorateTotals instead
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2726](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2726) [medusa/src/services/cart.ts:2857](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2857)
___ ___
@@ -777,7 +797,7 @@ the deleted cart or undefined if the cart was not found.
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2418](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2418) [medusa/src/services/cart.ts:2549](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2549)
___ ___
@@ -792,7 +812,7 @@ Removes a payment session from the cart.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to remove from | | `cartId` | `string` | the id of the cart to remove from |
| `providerId` | `string` | the id of the provider whoose payment session should be removed. | | `providerId` | `string` | the id of the provider whose payment session should be removed. |
#### Returns #### Returns
@@ -802,7 +822,7 @@ the resulting cart.
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1964](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1964) [medusa/src/services/cart.ts:2072](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2072)
___ ___
@@ -822,7 +842,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2531](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2531) [medusa/src/services/cart.ts:2662](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2662)
___ ___
@@ -848,7 +868,7 @@ custom shipping option
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2181](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2181) [medusa/src/services/cart.ts:2312](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2312)
___ ___
@@ -868,7 +888,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2777](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2777) [medusa/src/services/cart.ts:2908](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2908)
___ ___
@@ -888,7 +908,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:447](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L447) [medusa/src/services/cart.ts:490](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L490)
___ ___
@@ -911,7 +931,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:196](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L196) [medusa/src/services/cart.ts:209](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L209)
___ ___
@@ -936,7 +956,7 @@ void
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1213](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1213) [medusa/src/services/cart.ts:1321](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1321)
___ ___
@@ -956,7 +976,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2650](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2650) [medusa/src/services/cart.ts:2781](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2781)
___ ___
@@ -971,7 +991,7 @@ Refreshes a payment session on a cart
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to remove from | | `cartId` | `string` | the id of the cart to remove from |
| `providerId` | `string` | the id of the provider whoose payment session should be removed. | | `providerId` | `string` | the id of the provider whose payment session should be removed. |
#### Returns #### Returns
@@ -981,7 +1001,7 @@ the resulting cart.
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2016](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2016) [medusa/src/services/cart.ts:2124](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2124)
___ ___
@@ -1006,7 +1026,7 @@ the resulting cart
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1506](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1506) [medusa/src/services/cart.ts:1614](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1614)
___ ___
@@ -1031,7 +1051,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:479](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L479) [medusa/src/services/cart.ts:522](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L522)
___ ___
@@ -1057,7 +1077,7 @@ the cart document.
#### Defined in #### Defined in
[medusa/src/services/cart.ts:213](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L213) [medusa/src/services/cart.ts:226](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L226)
___ ___
@@ -1065,8 +1085,6 @@ ___
▸ `Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`Cart`\> ▸ `Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`Cart`\>
**`Deprecated`**
#### Parameters #### Parameters
| Name | Type | | Name | Type |
@@ -1079,9 +1097,11 @@ ___
`Promise`<`Cart`\> `Promise`<`Cart`\>
**`Deprecated`**
#### Defined in #### Defined in
[medusa/src/services/cart.ts:261](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L261) [medusa/src/services/cart.ts:289](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L289)
___ ___
@@ -1103,7 +1123,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:289](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L289) [medusa/src/services/cart.ts:317](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L317)
___ ___
@@ -1131,7 +1151,7 @@ resolves to the updated result.
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2459](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2459) [medusa/src/services/cart.ts:2590](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2590)
___ ___
@@ -1154,7 +1174,7 @@ Selects a payment session for a cart and creates a payment object in the externa
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1669](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1669) [medusa/src/services/cart.ts:1777](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1777)
___ ___
@@ -1182,7 +1202,7 @@ the result of the update operation.
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1785](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1785) [medusa/src/services/cart.ts:1893](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1893)
___ ___
@@ -1208,7 +1228,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2279](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2279) [medusa/src/services/cart.ts:2410](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2410)
___ ___
@@ -1232,7 +1252,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -1252,19 +1272,19 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2668](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2668) [medusa/src/services/cart.ts:2799](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2799)
___ ___
### update ### update
▸ **update**(`cartId`, `data`): `Promise`<`Cart`\> ▸ **update**(`cartOrId`, `data`): `Promise`<`Cart`\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `cartId` | `string` | | `cartOrId` | `string` \| `Cart` |
| `data` | `CartUpdateProps` | | `data` | `CartUpdateProps` |
#### Returns #### Returns
@@ -1273,7 +1293,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1039](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1039) [medusa/src/services/cart.ts:1154](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1154)
___ ___
@@ -1299,7 +1319,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1294](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1294) [medusa/src/services/cart.ts:1402](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1402)
___ ___
@@ -1324,13 +1344,13 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1249](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1249) [medusa/src/services/cart.ts:1357](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1357)
___ ___
### updateLineItem ### updateLineItem
▸ **updateLineItem**(`cartId`, `lineItemId`, `lineItemUpdate`): `Promise`<`Cart`\> ▸ **updateLineItem**(`cartId`, `lineItemId`, `update`): `Promise`<`Cart`\>
Updates a cart's existing line item. Updates a cart's existing line item.
@@ -1340,7 +1360,7 @@ Updates a cart's existing line item.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to update | | `cartId` | `string` | the id of the cart to update |
| `lineItemId` | `string` | the id of the line item to update. | | `lineItemId` | `string` | the id of the line item to update. |
| `lineItemUpdate` | `LineItemUpdate` | the line item to update. Must include an id field. | | `update` | `LineItemUpdate` | - |
#### Returns #### Returns
@@ -1350,7 +1370,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:916](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L916) [medusa/src/services/cart.ts:1001](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1001)
___ ___
@@ -1375,7 +1395,7 @@ the resulting cart
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1557](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1557) [medusa/src/services/cart.ts:1665](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1665)
___ ___
@@ -1401,7 +1421,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/cart.ts:1332](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L1332) [medusa/src/services/cart.ts:1440](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L1440)
___ ___
@@ -1423,7 +1443,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/cart.ts:2200](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L2200) [medusa/src/services/cart.ts:2331](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L2331)
___ ___
@@ -1449,13 +1469,13 @@ a boolean indicating validation result
#### Defined in #### Defined in
[medusa/src/services/cart.ts:576](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L576) [medusa/src/services/cart.ts:620](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L620)
___ ___
### validateLineItemShipping\_ ### validateLineItemShipping\_
▸ `Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItem`): `boolean` ▸ `Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItemShippingProfiledId`): `boolean`
Checks if a given line item has a shipping method that can fulfill it. Checks if a given line item has a shipping method that can fulfill it.
Returns true if all products in the cart can be fulfilled with the current Returns true if all products in the cart can be fulfilled with the current
@@ -1466,7 +1486,7 @@ shipping methods.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `shippingMethods` | `ShippingMethod`[] | the set of shipping methods to check from | | `shippingMethods` | `ShippingMethod`[] | the set of shipping methods to check from |
| `lineItem` | `LineItem` | the line item | | `lineItemShippingProfiledId` | `string` | - |
#### Returns #### Returns
@@ -1476,7 +1496,7 @@ boolean representing whether shipping method is validated
#### Defined in #### Defined in
[medusa/src/services/cart.ts:545](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/cart.ts#L545) [medusa/src/services/cart.ts:591](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/cart.ts#L591)
___ ___
@@ -1500,4 +1520,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ClaimItemService.md
+22 -22
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ClaimItemService**(`__namedParameters`) • **new ClaimItemService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L26) [medusa/src/services/claim-item.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L26)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L24) [medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L24)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L22) [medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L22)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L23) [medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L23)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L21) [medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L21)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L20) [medusa/src/services/claim-item.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L20)
___ ___
@@ -130,7 +130,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -144,7 +144,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -162,7 +162,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L14) [medusa/src/services/claim-item.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L14)
## Accessors ## Accessors
@@ -180,7 +180,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -239,7 +239,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L43) [medusa/src/services/claim-item.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L43)
___ ___
@@ -262,7 +262,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:205](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L205) [medusa/src/services/claim-item.ts:205](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L205)
___ ___
@@ -287,7 +287,7 @@ the ClaimItem
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:224](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L224) [medusa/src/services/claim-item.ts:224](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L224)
___ ___
@@ -311,7 +311,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -332,7 +332,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim-item.ts:127](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim-item.ts#L127) [medusa/src/services/claim-item.ts:127](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim-item.ts#L127)
___ ___
@@ -356,4 +356,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ClaimService.md
+40 -40
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ClaimService**(`__namedParameters`) • **new ClaimService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/claim.ts:86](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L86) [medusa/src/services/claim.ts:86](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L86)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L68) [medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L68)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L72) [medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L72)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L69) [medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L69)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L73) [medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L73)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L74) [medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L74)
___ ___
@@ -126,7 +126,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L75) [medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L75)
___ ___
@@ -136,7 +136,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L71) [medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L71)
___ ___
@@ -146,7 +146,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L76) [medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L76)
___ ___
@@ -160,7 +160,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -170,7 +170,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L77) [medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L77)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L84) [medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L84)
___ ___
@@ -190,7 +190,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L78) [medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L78)
___ ___
@@ -200,7 +200,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L79) [medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L79)
___ ___
@@ -210,7 +210,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L70) [medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L70)
___ ___
@@ -220,7 +220,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L80) [medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L80)
___ ___
@@ -230,7 +230,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L81) [medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L81)
___ ___
@@ -240,7 +240,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L82) [medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L82)
___ ___
@@ -254,7 +254,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -275,7 +275,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L59) [medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L59)
## Accessors ## Accessors
@@ -293,7 +293,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -332,7 +332,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -352,7 +352,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:814](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L814) [medusa/src/services/claim.ts:814](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L814)
___ ___
@@ -372,7 +372,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:662](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L662) [medusa/src/services/claim.ts:662](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L662)
___ ___
@@ -398,7 +398,7 @@ created claim
#### Defined in #### Defined in
[medusa/src/services/claim.ts:331](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L331) [medusa/src/services/claim.ts:331](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L331)
___ ___
@@ -424,7 +424,7 @@ created claim
#### Defined in #### Defined in
[medusa/src/services/claim.ts:512](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L512) [medusa/src/services/claim.ts:512](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L512)
___ ___
@@ -449,7 +449,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:734](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L734) [medusa/src/services/claim.ts:734](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L734)
___ ___
@@ -479,7 +479,7 @@ the refund amount
#### Defined in #### Defined in
[medusa/src/services/claim.ts:273](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L273) [medusa/src/services/claim.ts:273](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L273)
___ ___
@@ -502,7 +502,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/claim.ts:870](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L870) [medusa/src/services/claim.ts:870](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L870)
___ ___
@@ -522,7 +522,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:688](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L688) [medusa/src/services/claim.ts:688](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L688)
___ ___
@@ -547,7 +547,7 @@ the order document
#### Defined in #### Defined in
[medusa/src/services/claim.ts:889](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L889) [medusa/src/services/claim.ts:889](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L889)
___ ___
@@ -571,7 +571,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -592,7 +592,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L125) [medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L125)
___ ___
@@ -612,7 +612,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/claim.ts:206](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/claim.ts#L206) [medusa/src/services/claim.ts:206](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/claim.ts#L206)
___ ___
@@ -636,4 +636,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/CurrencyService.md
+21 -21
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new CurrencyService**(`__namedParameters`) • **new CurrencyService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L29) [medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L29)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L25) [medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L25)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L26) [medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L26)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/currency.ts:27](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L27) [medusa/src/services/currency.ts:27](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L27)
___ ___
@@ -110,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L21) [medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L21)
## Accessors ## Accessors
@@ -158,7 +158,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -197,7 +197,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -212,8 +212,8 @@ currencies that match the query.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `Selector`<`Currency`\> | an object that defines rules to filter currencies by | | `selector` | `Selector`<`Currency`\> | an object that defines rules to filter currencies by |
| `config` | `FindConfig`<`Currency`\> | object that defines the scope for what should be returned | | `config` | `FindConfig`<`Currency`\> | object that defines the scope for what should be returned |
#### Returns #### Returns
@@ -225,7 +225,7 @@ an array containing the currencies as
#### Defined in #### Defined in
[medusa/src/services/currency.ts:78](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L78) [medusa/src/services/currency.ts:78](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L78)
___ ___
@@ -249,7 +249,7 @@ The currency
#### Defined in #### Defined in
[medusa/src/services/currency.ts:47](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L47) [medusa/src/services/currency.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L47)
___ ___
@@ -273,7 +273,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -298,7 +298,7 @@ The updated currency
#### Defined in #### Defined in
[medusa/src/services/currency.ts:100](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/currency.ts#L100) [medusa/src/services/currency.ts:100](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/currency.ts#L100)
___ ___
@@ -322,4 +322,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/CustomShippingOptionService.md
+16 -16
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new CustomShippingOptionService**(`__namedParameters`) • **new CustomShippingOptionService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/custom-shipping-option.ts#L18) [medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/custom-shipping-option.ts#L18)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/custom-shipping-option.ts#L16) [medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/custom-shipping-option.ts#L16)
___ ___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -161,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -192,7 +192,7 @@ resolves to the creation result
#### Defined in #### Defined in
[medusa/src/services/custom-shipping-option.ts:80](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/custom-shipping-option.ts#L80) [medusa/src/services/custom-shipping-option.ts:80](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/custom-shipping-option.ts#L80)
___ ___
@@ -217,7 +217,7 @@ custom shipping options matching the query
#### Defined in #### Defined in
[medusa/src/services/custom-shipping-option.ts:58](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/custom-shipping-option.ts#L58) [medusa/src/services/custom-shipping-option.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/custom-shipping-option.ts#L58)
___ ___
@@ -242,7 +242,7 @@ the requested custom shipping option.
#### Defined in #### Defined in
[medusa/src/services/custom-shipping-option.ts:31](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/custom-shipping-option.ts#L31) [medusa/src/services/custom-shipping-option.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/custom-shipping-option.ts#L31)
___ ___
@@ -266,7 +266,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -290,4 +290,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/CustomerGroupService.md
+23 -23
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new CustomerGroupService**(`__namedParameters`) • **new CustomerGroupService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `CustomerGroupConstructorProps` | | `«destructured»` | `CustomerGroupConstructorProps` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L24) [medusa/src/services/customer-group.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L24)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L21) [medusa/src/services/customer-group.ts:21](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L21)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L22) [medusa/src/services/customer-group.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L22)
___ ___
@@ -100,7 +100,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -132,7 +132,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -157,7 +157,7 @@ the customer group after insertion
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:89](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L89) [medusa/src/services/customer-group.ts:89](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L89)
___ ___
@@ -196,7 +196,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -220,7 +220,7 @@ the result of the create operation
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L65) [medusa/src/services/customer-group.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L65)
___ ___
@@ -244,7 +244,7 @@ a promise
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:153](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L153) [medusa/src/services/customer-group.ts:153](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L153)
___ ___
@@ -266,7 +266,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:257](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L257) [medusa/src/services/customer-group.ts:257](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L257)
___ ___
@@ -291,7 +291,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:176](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L176) [medusa/src/services/customer-group.ts:176](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L176)
___ ___
@@ -316,7 +316,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:194](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L194) [medusa/src/services/customer-group.ts:194](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L194)
___ ___
@@ -341,7 +341,7 @@ the customergroup with the provided id
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:236](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L236) [medusa/src/services/customer-group.ts:236](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L236)
___ ___
@@ -362,7 +362,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:35](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L35) [medusa/src/services/customer-group.ts:35](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L35)
___ ___
@@ -386,7 +386,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -411,7 +411,7 @@ resulting customer group
#### Defined in #### Defined in
[medusa/src/services/customer-group.ts:120](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer-group.ts#L120) [medusa/src/services/customer-group.ts:120](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer-group.ts#L120)
___ ___
@@ -435,4 +435,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/CustomerService.md
+40 -40
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate customers.
### constructor ### constructor
• **new CustomerService**(`__namedParameters`) • **new CustomerService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/customer.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L46) [medusa/src/services/customer.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L46)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,17 +78,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L37) [medusa/src/services/customer.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L37)
___ ___
### customerRepository\_ ### 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`]\> } • `Protected` `Readonly` **customerRepository\_**: `Repository`<`Customer`\> & { `listAndCount`: (`query`: `Object`, `q`: `undefined` \| `string`) => `Promise`<[`Customer`[], `number`]\> }
#### Defined in #### Defined in
[medusa/src/services/customer.ts:36](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L36) [medusa/src/services/customer.ts:36](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L36)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:38](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L38) [medusa/src/services/customer.ts:38](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L38)
___ ___
@@ -112,7 +112,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -144,7 +144,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L40) [medusa/src/services/customer.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L40)
## Accessors ## Accessors
@@ -162,7 +162,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -183,7 +183,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/services/customer.ts:519](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L519) [medusa/src/services/customer.ts:519](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L519)
___ ___
@@ -222,7 +222,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -240,7 +240,7 @@ the result of the count operation
#### Defined in #### Defined in
[medusa/src/services/customer.ts:178](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L178) [medusa/src/services/customer.ts:178](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L178)
___ ___
@@ -267,7 +267,7 @@ the result of create
#### Defined in #### Defined in
[medusa/src/services/customer.ts:306](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L306) [medusa/src/services/customer.ts:306](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L306)
___ ___
@@ -281,7 +281,7 @@ Deletes a customer from a given customer id.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `customerId` | `string` | the id of the customer to delete. Must be castable as an ObjectId | | `customerId` | `string` | the id of the customer to delete. Must be castable as an ObjectId |
#### Returns #### Returns
@@ -291,7 +291,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[medusa/src/services/customer.ts:565](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L565) [medusa/src/services/customer.ts:565](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L565)
___ ___
@@ -319,7 +319,7 @@ the generated JSON web token
#### Defined in #### Defined in
[medusa/src/services/customer.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L68) [medusa/src/services/customer.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L68)
___ ___
@@ -343,7 +343,7 @@ hashed password
#### Defined in #### Defined in
[medusa/src/services/customer.ts:293](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L293) [medusa/src/services/customer.ts:293](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L293)
___ ___
@@ -366,7 +366,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/customer.ts:111](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L111) [medusa/src/services/customer.ts:111](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L111)
___ ___
@@ -389,7 +389,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/customer.ts:143](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L143) [medusa/src/services/customer.ts:143](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L143)
___ ___
@@ -410,7 +410,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:249](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L249) [medusa/src/services/customer.ts:249](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L249)
___ ___
@@ -431,7 +431,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:502](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L502) [medusa/src/services/customer.ts:502](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L502)
___ ___
@@ -456,7 +456,7 @@ the customer document.
#### Defined in #### Defined in
[medusa/src/services/customer.ts:274](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L274) [medusa/src/services/customer.ts:274](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L274)
___ ___
@@ -466,8 +466,6 @@ ___
Gets a registered customer by email. Gets a registered customer by email.
**`Deprecated`**
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -481,9 +479,11 @@ Gets a registered customer by email.
the customer document. the customer document.
**`Deprecated`**
#### Defined in #### Defined in
[medusa/src/services/customer.ts:216](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L216) [medusa/src/services/customer.ts:216](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L216)
___ ___
@@ -508,7 +508,7 @@ the customer document.
#### Defined in #### Defined in
[medusa/src/services/customer.ts:261](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L261) [medusa/src/services/customer.ts:261](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L261)
___ ___
@@ -529,7 +529,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:239](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L239) [medusa/src/services/customer.ts:239](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L239)
___ ___
@@ -550,7 +550,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:230](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L230) [medusa/src/services/customer.ts:230](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L230)
___ ___
@@ -571,7 +571,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:185](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L185) [medusa/src/services/customer.ts:185](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L185)
___ ___
@@ -595,7 +595,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -609,7 +609,7 @@ Updates a customer.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `customerId` | `string` | the id of the variant. Must be a string that can be casted to an ObjectId | | `customerId` | `string` | the id of the variant. Must be a string that can be casted to an ObjectId |
| `update` | `UpdateCustomerInput` | an object with the update values. | | `update` | `UpdateCustomerInput` | an object with the update values. |
#### Returns #### Returns
@@ -620,7 +620,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/customer.ts:362](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L362) [medusa/src/services/customer.ts:362](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L362)
___ ___
@@ -642,7 +642,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/customer.ts:474](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L474) [medusa/src/services/customer.ts:474](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L474)
___ ___
@@ -667,7 +667,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/customer.ts:422](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/customer.ts#L422) [medusa/src/services/customer.ts:422](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/customer.ts#L422)
___ ___
@@ -691,4 +691,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/DiscountConditionService.md
+20 -20
View File
@@ -14,13 +14,13 @@ Provides layer to manipulate discount conditions.
### constructor ### constructor
• **new DiscountConditionService**(`__namedParameters`) • **new DiscountConditionService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L34) [medusa/src/services/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L34)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,17 +70,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
### discountConditionRepository\_ ### 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`\> } • `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` ; `relatedTable`: `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
[medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L31) [medusa/src/services/discount-condition.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L31)
___ ___
@@ -90,7 +90,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L32) [medusa/src/services/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L32)
___ ___
@@ -104,7 +104,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -118,7 +118,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -136,7 +136,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -175,7 +175,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -195,7 +195,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount-condition.ts:217](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L217) [medusa/src/services/discount-condition.ts:217](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L217)
___ ___
@@ -215,7 +215,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount-condition.ts:184](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L184) [medusa/src/services/discount-condition.ts:184](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L184)
___ ___
@@ -236,7 +236,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount-condition.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L45) [medusa/src/services/discount-condition.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L45)
___ ___
@@ -260,7 +260,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -281,7 +281,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount-condition.ts:111](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L111) [medusa/src/services/discount-condition.ts:111](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L111)
___ ___
@@ -305,7 +305,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -325,4 +325,4 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount-condition.ts:74](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount-condition.ts#L74) [medusa/src/services/discount-condition.ts:74](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount-condition.ts#L74)
www/apps/docs/content/references/services/classes/DiscountService.md
+50 -50
View File
@@ -14,13 +14,13 @@ Provides layer to manipulate discounts.
### constructor ### constructor
• **new DiscountService**(`__namedParameters`) • **new DiscountService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
#### Overrides #### Overrides
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/discount.ts:71](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L71) [medusa/src/services/discount.ts:71](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L71)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,17 +80,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L58) [medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L58)
___ ___
### discountConditionRepository\_ ### 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`\> } • `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` ; `relatedTable`: `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
[medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L62) [medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L62)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L63) [medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L63)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L57) [medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L57)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L59) [medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L59)
___ ___
@@ -130,7 +130,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L68) [medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L68)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L69) [medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L69)
___ ___
@@ -150,7 +150,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L60) [medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L60)
___ ___
@@ -164,7 +164,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -174,7 +174,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L65) [medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L65)
___ ___
@@ -184,7 +184,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L66) [medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L66)
___ ___
@@ -194,7 +194,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L67) [medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L67)
___ ___
@@ -204,7 +204,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L64) [medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L64)
___ ___
@@ -218,7 +218,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -236,7 +236,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -261,7 +261,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:503](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L503) [medusa/src/services/discount.ts:503](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L503)
___ ___
@@ -300,7 +300,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -322,7 +322,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:605](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L605) [medusa/src/services/discount.ts:599](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L599)
___ ___
@@ -343,7 +343,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:797](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L797) [medusa/src/services/discount.ts:791](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L791)
___ ___
@@ -368,7 +368,7 @@ the result of the create operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:178](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L178) [medusa/src/services/discount.ts:178](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L178)
___ ___
@@ -393,7 +393,7 @@ the newly created dynamic code
#### Defined in #### Defined in
[medusa/src/services/discount.ts:431](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L431) [medusa/src/services/discount.ts:431](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L431)
___ ___
@@ -417,7 +417,7 @@ the result of the delete operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:563](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L563) [medusa/src/services/discount.ts:563](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L563)
___ ___
@@ -442,7 +442,7 @@ the newly created dynamic code
#### Defined in #### Defined in
[medusa/src/services/discount.ts:482](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L482) [medusa/src/services/discount.ts:482](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L482)
___ ___
@@ -462,7 +462,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:750](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L750) [medusa/src/services/discount.ts:744](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L744)
___ ___
@@ -482,7 +482,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:766](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L766) [medusa/src/services/discount.ts:760](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L760)
___ ___
@@ -502,7 +502,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L762) [medusa/src/services/discount.ts:756](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L756)
___ ___
@@ -522,7 +522,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:756](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L756) [medusa/src/services/discount.ts:750](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L750)
___ ___
@@ -542,7 +542,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:774](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L774) [medusa/src/services/discount.ts:768](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L768)
___ ___
@@ -563,7 +563,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:778](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L778) [medusa/src/services/discount.ts:772](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L772)
___ ___
@@ -586,7 +586,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L125) [medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L125)
___ ___
@@ -609,7 +609,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:142](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L142) [medusa/src/services/discount.ts:142](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L142)
___ ___
@@ -634,7 +634,7 @@ the discounts
#### Defined in #### Defined in
[medusa/src/services/discount.ts:307](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L307) [medusa/src/services/discount.ts:307](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L307)
___ ___
@@ -659,7 +659,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:538](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L538) [medusa/src/services/discount.ts:538](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L538)
___ ___
@@ -684,7 +684,7 @@ the discount
#### Defined in #### Defined in
[medusa/src/services/discount.ts:244](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L244) [medusa/src/services/discount.ts:244](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L244)
___ ___
@@ -709,7 +709,7 @@ the discount
#### Defined in #### Defined in
[medusa/src/services/discount.ts:278](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L278) [medusa/src/services/discount.ts:278](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L278)
___ ___
@@ -733,7 +733,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -758,7 +758,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:338](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L338) [medusa/src/services/discount.ts:338](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L338)
___ ___
@@ -779,20 +779,20 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:678](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L678) [medusa/src/services/discount.ts:672](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L672)
___ ___
### validateDiscountForProduct ### validateDiscountForProduct
▸ **validateDiscountForProduct**(`discountRuleId`, `productId`): `Promise`<`boolean`\> ▸ **validateDiscountForProduct**(`discountRuleId`, `productId?`): `Promise`<`boolean`\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `discountRuleId` | `string` | | `discountRuleId` | `string` |
| `productId` | `undefined` \| `string` | | `productId?` | `string` |
#### Returns #### Returns
@@ -800,7 +800,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/discount.ts:577](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L577) [medusa/src/services/discount.ts:577](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L577)
___ ___
@@ -830,7 +830,7 @@ the result of the create operation
#### Defined in #### Defined in
[medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/discount.ts#L107) [medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/discount.ts#L107)
___ ___
@@ -854,4 +854,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/DraftOrderService.md
+30 -30
View File
@@ -14,13 +14,13 @@ Handles draft orders
### constructor ### constructor
• **new DraftOrderService**(`__namedParameters`) • **new DraftOrderService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L67) [medusa/src/services/draft-order.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L67)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:61](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L61) [medusa/src/services/draft-order.ts:61](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L61)
___ ___
@@ -90,7 +90,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L65) [medusa/src/services/draft-order.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L65)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:57](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L57) [medusa/src/services/draft-order.ts:57](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L57)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L60) [medusa/src/services/draft-order.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L60)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:62](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L62) [medusa/src/services/draft-order.ts:62](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L62)
___ ___
@@ -134,7 +134,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -144,7 +144,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:59](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L59) [medusa/src/services/draft-order.ts:59](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L59)
___ ___
@@ -154,7 +154,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:58](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L58) [medusa/src/services/draft-order.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L58)
___ ___
@@ -164,7 +164,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:63](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L63) [medusa/src/services/draft-order.ts:63](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L63)
___ ___
@@ -174,7 +174,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:64](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L64) [medusa/src/services/draft-order.ts:64](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L64)
___ ___
@@ -188,7 +188,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -205,7 +205,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L52) [medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L52)
## Accessors ## Accessors
@@ -223,7 +223,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -262,7 +262,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -286,7 +286,7 @@ the created draft order
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:260](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L260) [medusa/src/services/draft-order.ts:260](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L260)
___ ___
@@ -310,7 +310,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:156](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L156) [medusa/src/services/draft-order.ts:156](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L156)
___ ___
@@ -335,7 +335,7 @@ list of draft orders
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:238](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L238) [medusa/src/services/draft-order.ts:238](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L238)
___ ___
@@ -360,7 +360,7 @@ draft orders
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:180](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L180) [medusa/src/services/draft-order.ts:180](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L180)
___ ___
@@ -385,7 +385,7 @@ the created order
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:420](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L420) [medusa/src/services/draft-order.ts:420](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L420)
___ ___
@@ -410,7 +410,7 @@ the draft order
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:98](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L98) [medusa/src/services/draft-order.ts:98](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L98)
___ ___
@@ -435,7 +435,7 @@ the draft order
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:131](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L131) [medusa/src/services/draft-order.ts:131](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L131)
___ ___
@@ -459,7 +459,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -485,7 +485,7 @@ the updated draft order
#### Defined in #### Defined in
[medusa/src/services/draft-order.ts:449](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/draft-order.ts#L449) [medusa/src/services/draft-order.ts:449](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/draft-order.ts#L449)
___ ___
@@ -509,4 +509,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/EventBusService.md
+54 -24
View File
@@ -17,13 +17,13 @@ subscribers when events happen. Events will run asynchronously.
### constructor ### constructor
• **new EventBusService**(`__namedParameters`, `config`, `isSingleton?`) • **new EventBusService**(`«destructured»`, `config`, `isSingleton?`)
#### Parameters #### Parameters
| Name | Type | Default value | | Name | Type | Default value |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | `undefined` | | `«destructured»` | `InjectedDependencies` | `undefined` |
| `config` | `any` | `undefined` | | `config` | `any` | `undefined` |
| `isSingleton` | `boolean` | `true` | | `isSingleton` | `boolean` | `true` |
@@ -33,7 +33,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L32) [medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L36)
## Properties ## Properties
@@ -47,7 +47,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -61,7 +61,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -75,7 +75,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -85,7 +85,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L24) [medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L27)
___ ___
@@ -95,7 +95,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L30) [medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L34)
___ ___
@@ -105,7 +105,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L27) [medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L30)
___
### logger\_
• `Protected` `Readonly` **logger\_**: `Logger`
#### Defined in
[medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L31)
___ ___
@@ -119,7 +129,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -129,7 +139,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L29) [medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L33)
___ ___
@@ -139,7 +149,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L25) [medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L28)
___ ___
@@ -153,7 +163,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -171,7 +181,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -210,7 +220,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -244,7 +254,7 @@ EventBusTypes.IEventBusService.emit
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:112](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L112) [medusa/src/services/event-bus.ts:117](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L117)
▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\> ▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\>
@@ -276,7 +286,7 @@ EventBusTypes.IEventBusService.emit
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:121](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L121) [medusa/src/services/event-bus.ts:126](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L126)
___ ___
@@ -290,7 +300,27 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:185](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L185) [medusa/src/services/event-bus.ts:190](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L190)
___
### listJobs
▸ `Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| `StagedJob`[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `listConfig` | `FindConfig`<`StagedJob`\> |
#### Returns
`Promise`<`never`[] \| `StagedJob`[]\>
#### Defined in
[medusa/src/services/event-bus.ts:220](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L220)
___ ___
@@ -314,7 +344,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -328,7 +358,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:175](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L175) [medusa/src/services/event-bus.ts:180](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L180)
___ ___
@@ -342,7 +372,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:180](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L180) [medusa/src/services/event-bus.ts:185](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L185)
___ ___
@@ -372,7 +402,7 @@ EventBusTypes.IEventBusService.subscribe
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:78](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L78) [medusa/src/services/event-bus.ts:83](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L83)
___ ___
@@ -402,7 +432,7 @@ EventBusTypes.IEventBusService.unsubscribe
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:98](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L98) [medusa/src/services/event-bus.ts:103](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L103)
___ ___
@@ -430,4 +460,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/services/event-bus.ts:49](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/event-bus.ts#L49) [medusa/src/services/event-bus.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/event-bus.ts#L54)
www/apps/docs/content/references/services/classes/FulfillmentProviderService.md
+25 -25
View File
@@ -1,6 +1,6 @@
# Class: FulfillmentProviderService # Class: FulfillmentProviderService
Helps retrive fulfillment providers Helps retrieve fulfillment providers
## Hierarchy ## Hierarchy
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:44](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L44) [medusa/src/services/fulfillment-provider.ts:44](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L44)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L40) [medusa/src/services/fulfillment-provider.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L40)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L42) [medusa/src/services/fulfillment-provider.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L42)
___ ___
@@ -102,7 +102,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -134,7 +134,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -173,7 +173,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -195,7 +195,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:147](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L147) [medusa/src/services/fulfillment-provider.ts:147](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L147)
___ ___
@@ -215,7 +215,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:122](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L122) [medusa/src/services/fulfillment-provider.ts:122](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L122)
___ ___
@@ -235,7 +235,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:140](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L140) [medusa/src/services/fulfillment-provider.ts:140](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L140)
___ ___
@@ -258,7 +258,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:107](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L107) [medusa/src/services/fulfillment-provider.ts:107](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L107)
___ ___
@@ -278,7 +278,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:165](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L165) [medusa/src/services/fulfillment-provider.ts:165](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L165)
___ ___
@@ -292,7 +292,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L67) [medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L67)
___ ___
@@ -312,7 +312,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L75) [medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L75)
___ ___
@@ -332,7 +332,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L53) [medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L53)
___ ___
@@ -358,7 +358,7 @@ document to fetch
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:184](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L184) [medusa/src/services/fulfillment-provider.ts:184](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L184)
___ ___
@@ -380,7 +380,7 @@ the payment fulfillment provider
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:96](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L96) [medusa/src/services/fulfillment-provider.ts:96](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L96)
___ ___
@@ -404,7 +404,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -426,7 +426,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:127](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L127) [medusa/src/services/fulfillment-provider.ts:127](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L127)
___ ___
@@ -446,7 +446,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment-provider.ts:160](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment-provider.ts#L160) [medusa/src/services/fulfillment-provider.ts:160](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment-provider.ts#L160)
___ ___
@@ -470,4 +470,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/FulfillmentService.md
+28 -28
View File
@@ -12,13 +12,13 @@ Handles Fulfillments
### constructor ### constructor
• **new FulfillmentService**(`__namedParameters`) • **new FulfillmentService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L47) [medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L47)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L40) [medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L40)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L41) [medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L41)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L43) [medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L43)
___ ___
@@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L38) [medusa/src/services/fulfillment.ts:38](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L38)
___ ___
@@ -122,7 +122,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L45) [medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L45)
___ ___
@@ -142,7 +142,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L39) [medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L39)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L37) [medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L37)
___ ___
@@ -162,7 +162,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L42) [medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L42)
___ ___
@@ -176,7 +176,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -194,7 +194,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -233,7 +233,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -259,7 +259,7 @@ the result of the save operation
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:260](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L260) [medusa/src/services/fulfillment.ts:260](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L260)
___ ___
@@ -288,7 +288,7 @@ the created fulfillments
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:205](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L205) [medusa/src/services/fulfillment.ts:205](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L205)
___ ___
@@ -315,7 +315,7 @@ the shipped fulfillment
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:312](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L312) [medusa/src/services/fulfillment.ts:312](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L312)
___ ___
@@ -340,7 +340,7 @@ the line items generated by the transformer.
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L109) [medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L109)
___ ___
@@ -361,7 +361,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L70) [medusa/src/services/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L70)
___ ___
@@ -386,7 +386,7 @@ the fulfillment
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:167](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L167) [medusa/src/services/fulfillment.ts:167](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L167)
___ ___
@@ -410,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -427,7 +427,7 @@ quantity from the quantity that was originally purchased.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `item` | `undefined` \| `LineItem` | the line item to check has sufficient fulfillable quantity. | | `item` | `undefined` \| `LineItem` | the line item to check has sufficient fulfillable quantity. |
| `quantity` | `number` | the quantity that is requested to be fulfilled. | | `quantity` | `number` | the quantity that is requested to be fulfilled. |
#### Returns #### Returns
@@ -439,7 +439,7 @@ a line item that has the requested fulfillment quantity
#### Defined in #### Defined in
[medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/fulfillment.ts#L134) [medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/fulfillment.ts#L134)
___ ___
@@ -463,4 +463,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/GiftCardService.md
+28 -28
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate gift cards.
### constructor ### constructor
• **new GiftCardService**(`__namedParameters`) • **new GiftCardService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L39) [medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L39)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:33](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L33) [medusa/src/services/gift-card.ts:33](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L33)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L29) [medusa/src/services/gift-card.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L29)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:31](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L31) [medusa/src/services/gift-card.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L31)
___ ___
@@ -112,7 +112,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:32](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L32) [medusa/src/services/gift-card.ts:32](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L32)
___ ___
@@ -136,7 +136,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L35) [medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L35)
## Accessors ## Accessors
@@ -170,7 +170,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -209,7 +209,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -233,7 +233,7 @@ the result of the create operation
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:122](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L122) [medusa/src/services/gift-card.ts:122](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L122)
___ ___
@@ -253,7 +253,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:106](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L106) [medusa/src/services/gift-card.ts:106](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L106)
___ ___
@@ -277,7 +277,7 @@ the result of the delete operation
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:295](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L295) [medusa/src/services/gift-card.ts:295](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L295)
___ ___
@@ -300,7 +300,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:98](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L98) [medusa/src/services/gift-card.ts:98](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L98)
___ ___
@@ -323,7 +323,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:74](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L74) [medusa/src/services/gift-card.ts:74](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L74)
___ ___
@@ -348,7 +348,7 @@ the gift card
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:215](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L215) [medusa/src/services/gift-card.ts:215](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L215)
___ ___
@@ -369,7 +369,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:229](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L229) [medusa/src/services/gift-card.ts:229](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L229)
___ ___
@@ -390,7 +390,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L182) [medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L182)
___ ___
@@ -414,7 +414,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -439,7 +439,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:249](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L249) [medusa/src/services/gift-card.ts:249](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L249)
___ ___
@@ -463,7 +463,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -481,7 +481,7 @@ the generated gift card code
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:58](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L58) [medusa/src/services/gift-card.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L58)
___ ___
@@ -507,4 +507,4 @@ the tax rate for the gift card
#### Defined in #### Defined in
[medusa/src/services/gift-card.ts:161](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/gift-card.ts#L161) [medusa/src/services/gift-card.ts:161](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/gift-card.ts#L161)
www/apps/docs/content/references/services/classes/IdempotencyKeyService.md
+19 -19
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new IdempotencyKeyService**(`__namedParameters`) • **new IdempotencyKeyService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L25) [medusa/src/services/idempotency-key.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L25)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L23) [medusa/src/services/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L23)
___ ___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -161,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -187,7 +187,7 @@ the created idempotency key
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L68) [medusa/src/services/idempotency-key.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L68)
___ ___
@@ -214,7 +214,7 @@ the existing or created idempotency key
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L40) [medusa/src/services/idempotency-key.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L40)
___ ___
@@ -238,7 +238,7 @@ result of the update operation
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:138](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L138) [medusa/src/services/idempotency-key.ts:138](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L138)
___ ___
@@ -262,7 +262,7 @@ idempotency key
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:86](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L86) [medusa/src/services/idempotency-key.ts:86](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L86)
___ ___
@@ -286,7 +286,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -311,7 +311,7 @@ result of the update operation
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:167](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L167) [medusa/src/services/idempotency-key.ts:167](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L167)
___ ___
@@ -335,7 +335,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -364,4 +364,4 @@ new updated idempotency key
#### Defined in #### Defined in
[medusa/src/services/idempotency-key.ts:196](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/idempotency-key.ts#L196) [medusa/src/services/idempotency-key.ts:196](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/idempotency-key.ts#L196)
www/apps/docs/content/references/services/classes/LineItemAdjustmentService.md
+22 -22
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate line item adjustments.
### constructor ### constructor
• **new LineItemAdjustmentService**(`__namedParameters`) • **new LineItemAdjustmentService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `LineItemAdjustmentServiceProps` | | `«destructured»` | `LineItemAdjustmentServiceProps` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L36) [medusa/src/services/line-item-adjustment.ts:36](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L36)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L34) [medusa/src/services/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L34)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L33) [medusa/src/services/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L33)
___ ___
@@ -102,7 +102,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -134,7 +134,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -173,7 +173,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -197,7 +197,7 @@ line item adjustment
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:86](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L86) [medusa/src/services/line-item-adjustment.ts:86](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L86)
___ ___
@@ -222,7 +222,7 @@ a line item adjustment or undefined if no adjustment was created
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:262](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L262) [medusa/src/services/line-item-adjustment.ts:262](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L262)
___ ___
@@ -248,7 +248,7 @@ otherwise returns an array of line item adjustments for each line item in the ca
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:290](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L290) [medusa/src/services/line-item-adjustment.ts:290](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L290)
___ ___
@@ -272,7 +272,7 @@ the result of the delete operation
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L153) [medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L153)
___ ___
@@ -298,7 +298,7 @@ a line item adjustment or undefined if no adjustment was created
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:188](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L188) [medusa/src/services/line-item-adjustment.ts:188](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L188)
___ ___
@@ -323,7 +323,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L136) [medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L136)
___ ___
@@ -348,7 +348,7 @@ the line item adjustment.
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:53](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L53) [medusa/src/services/line-item-adjustment.ts:53](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L53)
___ ___
@@ -372,7 +372,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -397,7 +397,7 @@ line item adjustment
#### Defined in #### Defined in
[medusa/src/services/line-item-adjustment.ts:104](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item-adjustment.ts#L104) [medusa/src/services/line-item-adjustment.ts:104](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item-adjustment.ts#L104)
___ ___
@@ -421,4 +421,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/LineItemService.md
+39 -39
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new LineItemService**(`__namedParameters`) • **new LineItemService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L56) [medusa/src/services/line-item.ts:57](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L57)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L47) [medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L48)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L52) [medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L53)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L46) [medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L47)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L53) [medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L54)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L45) [medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L46)
___ ___
@@ -130,7 +130,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L50) [medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L51)
___ ___
@@ -150,7 +150,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L49) [medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L50)
___ ___
@@ -160,7 +160,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L48) [medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L49)
___ ___
@@ -170,7 +170,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L51) [medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L52)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L54) [medusa/src/services/line-item.ts:55](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L55)
___ ___
@@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -212,7 +212,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -251,7 +251,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -274,7 +274,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:514](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L514) [medusa/src/services/line-item.ts:541](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L541)
___ ___
@@ -305,7 +305,7 @@ the created line item
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:392](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L392) [medusa/src/services/line-item.ts:421](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L421)
___ ___
@@ -331,7 +331,7 @@ the created line items
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:130](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L130) [medusa/src/services/line-item.ts:131](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L131)
___ ___
@@ -355,7 +355,7 @@ a new line item tax line
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:506](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L506) [medusa/src/services/line-item.ts:533](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L533)
___ ___
@@ -379,7 +379,7 @@ the result of the delete operation
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:465](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L465) [medusa/src/services/line-item.ts:494](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L494)
___ ___
@@ -387,11 +387,6 @@ ___
▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| `LineItem`\> ▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| `LineItem`\>
**`Deprecated`**
no the cascade on the entity takes care of it
Deletes a line item with the tax lines.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -404,9 +399,14 @@ Deletes a line item with the tax lines.
the result of the delete operation the result of the delete operation
**`Deprecated`**
no the cascade on the entity takes care of it
Deletes a line item with the tax lines.
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:485](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L485) [medusa/src/services/line-item.ts:516](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L516)
___ ___
@@ -438,7 +438,7 @@ Generate a single or multiple line item without persisting the data into the db
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:191](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L191) [medusa/src/services/line-item.ts:192](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L192)
___ ___
@@ -468,7 +468,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:316](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L316) [medusa/src/services/line-item.ts:337](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L337)
___ ___
@@ -489,7 +489,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:83](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L83) [medusa/src/services/line-item.ts:84](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L84)
___ ___
@@ -514,7 +514,7 @@ the line item
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:104](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L104) [medusa/src/services/line-item.ts:105](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L105)
___ ___
@@ -538,7 +538,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -563,7 +563,7 @@ the updated line item(s)
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:422](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L422) [medusa/src/services/line-item.ts:451](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L451)
___ ___
@@ -592,7 +592,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/line-item.ts:585](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/line-item.ts#L585) [medusa/src/services/line-item.ts:612](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/line-item.ts#L612)
___ ___
@@ -616,4 +616,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/MiddlewareService.md
+19 -19
View File
@@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L22) [medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/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
[medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L17) [medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L17)
___ ___
@@ -30,7 +30,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L18) [medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L18)
___ ___
@@ -40,7 +40,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L19) [medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L19)
___ ___
@@ -50,7 +50,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L20) [medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L20)
## Methods ## Methods
@@ -64,8 +64,8 @@ Adds a middleware function to be called after authentication is completed.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. | | `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. |
| `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware | | `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware |
#### Returns #### Returns
@@ -75,7 +75,7 @@ void
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L60) [medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L60)
___ ___
@@ -89,8 +89,8 @@ Adds a middleware function to be called before authentication is completed.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. | | `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. |
| `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware | | `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware |
#### Returns #### Returns
@@ -100,7 +100,7 @@ void
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L79) [medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L79)
___ ___
@@ -114,7 +114,7 @@ Adds a middleware function to be called before cart creation
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `middleware` | `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> | the middleware function. Should return a middleware function. | | `middleware` | `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> | the middleware function. Should return a middleware function. |
#### Returns #### Returns
@@ -122,7 +122,7 @@ Adds a middleware function to be called before cart creation
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L96) [medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L96)
___ ___
@@ -143,7 +143,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L29) [medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L29)
___ ___
@@ -163,7 +163,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L34) [medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L34)
___ ___
@@ -185,7 +185,7 @@ Adds post authentication middleware to an express app.
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L106) [medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L106)
___ ___
@@ -207,7 +207,7 @@ Adds pre authentication middleware to an express app.
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L117) [medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L117)
___ ___
@@ -221,7 +221,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L123) [medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L123)
___ ___
@@ -245,4 +245,4 @@ nothing if the middleware is a function
#### Defined in #### Defined in
[medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/middleware.ts#L43) [medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/middleware.ts#L43)
www/apps/docs/content/references/services/classes/NewTotalsService.md
+82 -82
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new NewTotalsService**(`__namedParameters`) • **new NewTotalsService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L67) [medusa/src/services/new-totals.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L67)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L64) [medusa/src/services/new-totals.ts:64](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L64)
___ ___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L65) [medusa/src/services/new-totals.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L65)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:63](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L63) [medusa/src/services/new-totals.ts:63](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L63)
___ ___
@@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -142,7 +142,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -181,13 +181,13 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
### getGiftCardTotals ### getGiftCardTotals
▸ **getGiftCardTotals**(`giftCardableAmount`, `__namedParameters`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> ▸ **getGiftCardTotals**(`giftCardableAmount`, `«destructured»`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\>
Calculate and return the gift cards totals Calculate and return the gift cards totals
@@ -196,10 +196,10 @@ Calculate and return the gift cards totals
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `giftCardableAmount` | `number` | | `giftCardableAmount` | `number` |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.giftCardTransactions?` | `GiftCardTransaction`[] | | › `giftCardTransactions?` | `GiftCardTransaction`[] |
| `__namedParameters.giftCards?` | `GiftCard`[] | | › `giftCards?` | `GiftCard`[] |
| `__namedParameters.region` | `Region` | | › `region` | `Region` |
#### Returns #### Returns
@@ -207,13 +207,13 @@ Calculate and return the gift cards totals
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:447](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L447) [medusa/src/services/new-totals.ts:447](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L447)
___ ___
### getGiftCardTransactionsTotals ### getGiftCardTransactionsTotals
▸ **getGiftCardTransactionsTotals**(`__namedParameters`): `Object` ▸ **getGiftCardTransactionsTotals**(`«destructured»`): `Object`
Calculate and return the gift cards totals based on their transactions Calculate and return the gift cards totals based on their transactions
@@ -221,11 +221,11 @@ Calculate and return the gift cards totals based on their transactions
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.giftCardTransactions` | `GiftCardTransaction`[] | | › `giftCardTransactions` | `GiftCardTransaction`[] |
| `__namedParameters.region` | `Object` | | › `region` | `Object` |
| `__namedParameters.region.gift_cards_taxable` | `boolean` | | › `region.gift_cards_taxable` | `boolean` |
| `__namedParameters.region.tax_rate` | `number` | | › `region.tax_rate` | `number` |
#### Returns #### Returns
@@ -238,13 +238,13 @@ Calculate and return the gift cards totals based on their transactions
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:526](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L526) [medusa/src/services/new-totals.ts:526](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L526)
___ ___
### getLineItemRefund ### getLineItemRefund
▸ **getLineItemRefund**(`lineItem`, `__namedParameters`): `number` ▸ **getLineItemRefund**(`lineItem`, `«destructured»`): `number`
Return the amount that can be refund on a line item Return the amount that can be refund on a line item
@@ -258,9 +258,9 @@ Return the amount that can be refund on a line item
| `lineItem.quantity` | `number` | | `lineItem.quantity` | `number` |
| `lineItem.tax_lines` | `LineItemTaxLine`[] | | `lineItem.tax_lines` | `LineItemTaxLine`[] |
| `lineItem.unit_price` | `number` | | `lineItem.unit_price` | `number` |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.taxRate?` | ``null`` \| `number` | | › `taxRate?` | ``null`` \| `number` |
#### Returns #### Returns
@@ -268,13 +268,13 @@ Return the amount that can be refund on a line item
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:333](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L333) [medusa/src/services/new-totals.ts:333](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L333)
___ ___
### getLineItemRefundLegacy ### getLineItemRefundLegacy
▸ `Protected` **getLineItemRefundLegacy**(`lineItem`, `__namedParameters`): `number` ▸ `Protected` **getLineItemRefundLegacy**(`lineItem`, `«destructured»`): `number`
#### Parameters #### Parameters
@@ -285,9 +285,9 @@ ___
| `lineItem.includes_tax` | `boolean` | | `lineItem.includes_tax` | `boolean` |
| `lineItem.quantity` | `number` | | `lineItem.quantity` | `number` |
| `lineItem.unit_price` | `number` | | `lineItem.unit_price` | `number` |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.taxRate` | `number` | | › `taxRate` | `number` |
#### Returns #### Returns
@@ -295,13 +295,13 @@ ___
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:403](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L403) [medusa/src/services/new-totals.ts:403](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L403)
___ ___
### getLineItemTotals ### getLineItemTotals
▸ **getLineItemTotals**(`items`, `__namedParameters`): `Promise`<{ `[lineItemId: string]`: `LineItemTotals`; }\> ▸ **getLineItemTotals**(`items`, `«destructured»`): `Promise`<{ `[lineItemId: string]`: `LineItemTotals`; }\>
Calculate and return the items totals for either the legacy calculation or the new calculation Calculate and return the items totals for either the legacy calculation or the new calculation
@@ -310,10 +310,10 @@ Calculate and return the items totals for either the legacy calculation or the n
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `items` | `LineItem` \| `LineItem`[] | | `items` | `LineItem` \| `LineItem`[] |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.includeTax?` | `boolean` | | › `includeTax?` | `boolean` |
| `__namedParameters.taxRate?` | ``null`` \| `number` | | › `taxRate?` | ``null`` \| `number` |
#### Returns #### Returns
@@ -321,13 +321,13 @@ Calculate and return the items totals for either the legacy calculation or the n
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:87](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L87) [medusa/src/services/new-totals.ts:87](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L87)
___ ___
### getLineItemTotalsLegacy ### getLineItemTotalsLegacy
▸ `Protected` **getLineItemTotalsLegacy**(`item`, `__namedParameters`): `Promise`<`LineItemTotals`\> ▸ `Protected` **getLineItemTotalsLegacy**(`item`, `«destructured»`): `Promise`<`LineItemTotals`\>
Calculate and return the legacy calculated totals using the tax rate Calculate and return the legacy calculated totals using the tax rate
@@ -336,12 +336,12 @@ Calculate and return the legacy calculated totals using the tax rate
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `item` | `LineItem` | | `item` | `LineItem` |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.lineItemAllocation` | `Object` | | › `lineItemAllocation` | `Object` |
| `__namedParameters.lineItemAllocation.discount?` | `DiscountAllocation` | | › `lineItemAllocation.discount?` | `DiscountAllocation` |
| `__namedParameters.lineItemAllocation.gift_card?` | `GiftCardAllocation` | | › `lineItemAllocation.gift_card?` | `GiftCardAllocation` |
| `__namedParameters.taxRate` | `number` | | › `taxRate` | `number` |
#### Returns #### Returns
@@ -349,13 +349,13 @@ Calculate and return the legacy calculated totals using the tax rate
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:254](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L254) [medusa/src/services/new-totals.ts:254](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L254)
___ ___
### getLineItemTotals\_ ### getLineItemTotals\_
▸ `Protected` **getLineItemTotals_**(`item`, `__namedParameters`): `Promise`<`LineItemTotals`\> ▸ `Protected` **getLineItemTotals_**(`item`, `«destructured»`): `Promise`<`LineItemTotals`\>
Calculate and return the totals for an item Calculate and return the totals for an item
@@ -364,13 +364,13 @@ Calculate and return the totals for an item
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `item` | `LineItem` | | `item` | `LineItem` |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.includeTax?` | `boolean` | | › `includeTax?` | `boolean` |
| `__namedParameters.lineItemAllocation` | `Object` | | › `lineItemAllocation` | `Object` |
| `__namedParameters.lineItemAllocation.discount?` | `DiscountAllocation` | | › `lineItemAllocation.discount?` | `DiscountAllocation` |
| `__namedParameters.lineItemAllocation.gift_card?` | `GiftCardAllocation` | | › `lineItemAllocation.gift_card?` | `GiftCardAllocation` |
| `__namedParameters.taxLines?` | `LineItemTaxLine`[] | | › `taxLines?` | `LineItemTaxLine`[] |
#### Returns #### Returns
@@ -378,13 +378,13 @@ Calculate and return the totals for an item
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:147](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L147) [medusa/src/services/new-totals.ts:147](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L147)
___ ___
### getShippingMethodTotals ### getShippingMethodTotals
▸ **getShippingMethodTotals**(`shippingMethods`, `__namedParameters`): `Promise`<{ `[shippingMethodId: string]`: `ShippingMethodTotals`; }\> ▸ **getShippingMethodTotals**(`shippingMethods`, `«destructured»`): `Promise`<{ `[shippingMethodId: string]`: `ShippingMethodTotals`; }\>
Calculate and return the shipping methods totals for either the legacy calculation or the new calculation Calculate and return the shipping methods totals for either the legacy calculation or the new calculation
@@ -393,11 +393,11 @@ Calculate and return the shipping methods totals for either the legacy calculati
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `shippingMethods` | `ShippingMethod` \| `ShippingMethod`[] | | `shippingMethods` | `ShippingMethod` \| `ShippingMethod`[] |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.discounts?` | `Discount`[] | | › `discounts?` | `Discount`[] |
| `__namedParameters.includeTax?` | `boolean` | | › `includeTax?` | `boolean` |
| `__namedParameters.taxRate?` | ``null`` \| `number` | | › `taxRate?` | ``null`` \| `number` |
#### Returns #### Returns
@@ -405,25 +405,25 @@ Calculate and return the shipping methods totals for either the legacy calculati
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:572](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L572) [medusa/src/services/new-totals.ts:572](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L572)
___ ___
### getShippingMethodTotalsLegacy ### getShippingMethodTotalsLegacy
▸ `Protected` **getShippingMethodTotalsLegacy**(`shippingMethod`, `__namedParameters`): `Promise`<`ShippingMethodTotals`\> ▸ `Protected` **getShippingMethodTotalsLegacy**(`shippingMethod`, `«destructured»`): `Promise`<`ShippingMethodTotals`\>
Calculate and return the shipping method totals legacy using teh tax rate Calculate and return the shipping method totals legacy using the tax rate
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `shippingMethod` | `ShippingMethod` | | `shippingMethod` | `ShippingMethod` |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.discounts?` | `Discount`[] | | › `discounts?` | `Discount`[] |
| `__namedParameters.taxRate` | `number` | | › `taxRate` | `number` |
#### Returns #### Returns
@@ -431,13 +431,13 @@ Calculate and return the shipping method totals legacy using teh tax rate
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:729](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L729) [medusa/src/services/new-totals.ts:729](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L729)
___ ___
### getShippingMethodTotals\_ ### getShippingMethodTotals\_
▸ `Protected` **getShippingMethodTotals_**(`shippingMethod`, `__namedParameters`): `Promise`<`ShippingMethodTotals`\> ▸ `Protected` **getShippingMethodTotals_**(`shippingMethod`, `«destructured»`): `Promise`<`ShippingMethodTotals`\>
Calculate and return the shipping method totals Calculate and return the shipping method totals
@@ -446,11 +446,11 @@ Calculate and return the shipping method totals
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `shippingMethod` | `ShippingMethod` | | `shippingMethod` | `ShippingMethod` |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
| `__namedParameters.calculationContext` | `TaxCalculationContext` | | › `calculationContext` | `TaxCalculationContext` |
| `__namedParameters.discounts?` | `Discount`[] | | › `discounts?` | `Discount`[] |
| `__namedParameters.includeTax?` | `boolean` | | › `includeTax?` | `boolean` |
| `__namedParameters.taxLines?` | `ShippingMethodTaxLine`[] | | › `taxLines?` | `ShippingMethodTaxLine`[] |
#### Returns #### Returns
@@ -458,7 +458,7 @@ Calculate and return the shipping method totals
#### Defined in #### Defined in
[medusa/src/services/new-totals.ts:646](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/new-totals.ts#L646) [medusa/src/services/new-totals.ts:646](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/new-totals.ts#L646)
___ ___
@@ -482,7 +482,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -506,4 +506,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/NoteService.md
+21 -21
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new NoteService**(`__namedParameters`) • **new NoteService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/note.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L28) [medusa/src/services/note.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L28)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L26) [medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L26)
___ ___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L25) [medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L25)
___ ___
@@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/note.ts:19](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L19) [medusa/src/services/note.ts:19](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L19)
## Accessors ## Accessors
@@ -150,7 +150,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -189,7 +189,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -215,7 +215,7 @@ resolves to the creation result
#### Defined in #### Defined in
[medusa/src/services/note.ts:119](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L119) [medusa/src/services/note.ts:119](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L119)
___ ___
@@ -237,7 +237,7 @@ Deletes a given note
#### Defined in #### Defined in
[medusa/src/services/note.ts:177](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L177) [medusa/src/services/note.ts:177](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L177)
___ ___
@@ -262,7 +262,7 @@ notes related to the given search.
#### Defined in #### Defined in
[medusa/src/services/note.ts:77](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L77) [medusa/src/services/note.ts:77](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L77)
___ ___
@@ -287,7 +287,7 @@ notes related to the given search.
#### Defined in #### Defined in
[medusa/src/services/note.ts:98](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L98) [medusa/src/services/note.ts:98](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L98)
___ ___
@@ -312,7 +312,7 @@ which resolves to the requested note.
#### Defined in #### Defined in
[medusa/src/services/note.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L42) [medusa/src/services/note.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L42)
___ ___
@@ -336,7 +336,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -361,7 +361,7 @@ resolves to the updated element
#### Defined in #### Defined in
[medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/note.ts#L155) [medusa/src/services/note.ts:155](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/note.ts#L155)
___ ___
@@ -385,4 +385,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/NotificationService.md
+28 -28
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L34) [medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L34)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/notification.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L25) [medusa/src/services/notification.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L25)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L26) [medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L26)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/notification.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L29) [medusa/src/services/notification.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L29)
___ ___
@@ -110,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L32) [medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L32)
___ ___
@@ -130,7 +130,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/notification.ts:30](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L30) [medusa/src/services/notification.ts:30](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L30)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L24) [medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L24)
___ ___
@@ -154,7 +154,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -172,7 +172,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -211,7 +211,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -238,7 +238,7 @@ the result of notification subscribed
#### Defined in #### Defined in
[medusa/src/services/notification.ts:185](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L185) [medusa/src/services/notification.ts:185](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L185)
___ ___
@@ -263,7 +263,7 @@ the notifications that satisfy the query.
#### Defined in #### Defined in
[medusa/src/services/notification.ts:78](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L78) [medusa/src/services/notification.ts:78](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L78)
___ ___
@@ -288,7 +288,7 @@ the notifications that satisfy the query as well as the count.
#### Defined in #### Defined in
[medusa/src/services/notification.ts:97](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L97) [medusa/src/services/notification.ts:97](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L97)
___ ___
@@ -311,7 +311,7 @@ used to generate on demand invoices or other documents.
#### Defined in #### Defined in
[medusa/src/services/notification.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L52) [medusa/src/services/notification.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L52)
___ ___
@@ -333,7 +333,7 @@ Takes a list of notification provider ids and persists them in the database.
#### Defined in #### Defined in
[medusa/src/services/notification.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L60) [medusa/src/services/notification.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L60)
___ ___
@@ -349,7 +349,7 @@ underlying provider's resendNotification method.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | the id of the notification | | `id` | `string` | the id of the notification |
| `config` | `FindConfig`<`Notification`\> | any configuration that might override the previous send | | `config` | `FindConfig`<`Notification`\> | any configuration that might override the previous send |
#### Returns #### Returns
@@ -359,7 +359,7 @@ the newly created notification
#### Defined in #### Defined in
[medusa/src/services/notification.ts:265](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L265) [medusa/src/services/notification.ts:265](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L265)
___ ___
@@ -384,7 +384,7 @@ the notification
#### Defined in #### Defined in
[medusa/src/services/notification.ts:118](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L118) [medusa/src/services/notification.ts:118](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L118)
___ ___
@@ -409,7 +409,7 @@ the notification provider
#### Defined in #### Defined in
[medusa/src/services/notification.ts:166](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L166) [medusa/src/services/notification.ts:166](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L166)
___ ___
@@ -426,7 +426,7 @@ method. Persists the Notification in the database.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `event` | `string` | the name of the event | | `event` | `string` | the name of the event |
| `eventData` | `Record`<`string`, `unknown`\> | the data the event was sent with | | `eventData` | `Record`<`string`, `unknown`\> | the data the event was sent with |
| `providerId` | `string` | the provider that should hande the event. | | `providerId` | `string` | the provider that should handle the event. |
#### Returns #### Returns
@@ -436,7 +436,7 @@ the created notification
#### Defined in #### Defined in
[medusa/src/services/notification.ts:217](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L217) [medusa/src/services/notification.ts:217](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L217)
___ ___
@@ -460,7 +460,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -483,7 +483,7 @@ Subscribes a given provider to an event.
#### Defined in #### Defined in
[medusa/src/services/notification.ts:145](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/notification.ts#L145) [medusa/src/services/notification.ts:145](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/notification.ts#L145)
___ ___
@@ -507,4 +507,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/OauthService.md
+22 -22
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L28) [medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L28)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L24) [medusa/src/services/oauth.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L24)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L26) [medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L26)
___ ___
@@ -100,7 +100,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L25) [medusa/src/services/oauth.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L25)
___ ___
@@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -141,7 +141,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L19) [medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L19)
## Accessors ## Accessors
@@ -159,7 +159,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -198,7 +198,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -218,7 +218,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:87](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L87) [medusa/src/services/oauth.ts:87](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L87)
___ ___
@@ -240,7 +240,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:121](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L121) [medusa/src/services/oauth.ts:121](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L121)
___ ___
@@ -260,7 +260,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:79](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L79) [medusa/src/services/oauth.ts:79](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L79)
___ ___
@@ -280,7 +280,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:155](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L155) [medusa/src/services/oauth.ts:155](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L155)
___ ___
@@ -300,7 +300,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:111](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L111) [medusa/src/services/oauth.ts:111](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L111)
___ ___
@@ -320,7 +320,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L54) [medusa/src/services/oauth.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L54)
___ ___
@@ -340,7 +340,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:36](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L36) [medusa/src/services/oauth.ts:36](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L36)
___ ___
@@ -364,7 +364,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -385,7 +385,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/oauth.ts:100](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/oauth.ts#L100) [medusa/src/services/oauth.ts:100](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/oauth.ts#L100)
___ ___
@@ -409,4 +409,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/OrderEditItemChangeService.md
+21 -21
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new OrderEditItemChangeService**(`__namedParameters`) • **new OrderEditItemChangeService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:33](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L33) [medusa/src/services/order-edit-item-change.ts:33](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L33)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L29) [medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L29)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L30) [medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L30)
___ ___
@@ -100,7 +100,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L28) [medusa/src/services/order-edit-item-change.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L28)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L31) [medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L31)
___ ___
@@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -151,7 +151,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L22) [medusa/src/services/order-edit-item-change.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L22)
## Accessors ## Accessors
@@ -169,7 +169,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -208,7 +208,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -228,7 +228,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:81](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L81) [medusa/src/services/order-edit-item-change.ts:81](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L81)
___ ___
@@ -248,7 +248,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:97](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L97) [medusa/src/services/order-edit-item-change.ts:97](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L97)
___ ___
@@ -269,7 +269,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L69) [medusa/src/services/order-edit-item-change.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L69)
___ ___
@@ -290,7 +290,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit-item-change.ts:48](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit-item-change.ts#L48) [medusa/src/services/order-edit-item-change.ts:48](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit-item-change.ts#L48)
___ ___
@@ -314,7 +314,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -338,4 +338,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/OrderEditService.md
+42 -42
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new OrderEditService**(`__namedParameters`) • **new OrderEditService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:75](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L75) [medusa/src/services/order-edit.ts:75](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L75)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L69) [medusa/src/services/order-edit.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L69)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:73](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L73) [medusa/src/services/order-edit.ts:73](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L73)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:71](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L71) [medusa/src/services/order-edit.ts:71](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L71)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L68) [medusa/src/services/order-edit.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L68)
___ ___
@@ -120,7 +120,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -130,7 +130,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L67) [medusa/src/services/order-edit.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L67)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:72](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L72) [medusa/src/services/order-edit.ts:72](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L72)
___ ___
@@ -150,7 +150,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L63) [medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L63)
___ ___
@@ -160,7 +160,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L65) [medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L65)
___ ___
@@ -170,7 +170,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:70](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L70) [medusa/src/services/order-edit.ts:70](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L70)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L66) [medusa/src/services/order-edit.ts:66](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L66)
___ ___
@@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -215,7 +215,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L54) [medusa/src/services/order-edit.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L54)
## Accessors ## Accessors
@@ -233,7 +233,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -254,7 +254,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:541](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L541) [medusa/src/services/order-edit.ts:541](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L541)
___ ___
@@ -293,7 +293,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -315,7 +315,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:687](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L687) [medusa/src/services/order-edit.ts:687](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L687)
___ ___
@@ -337,7 +337,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:726](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L726) [medusa/src/services/order-edit.ts:726](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L726)
___ ___
@@ -359,7 +359,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:162](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L162) [medusa/src/services/order-edit.ts:162](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L162)
___ ___
@@ -382,7 +382,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:260](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L260) [medusa/src/services/order-edit.ts:260](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L260)
___ ___
@@ -402,7 +402,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:490](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L490) [medusa/src/services/order-edit.ts:490](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L490)
___ ___
@@ -422,7 +422,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:238](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L238) [medusa/src/services/order-edit.ts:238](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L238)
___ ___
@@ -442,7 +442,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:808](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L808) [medusa/src/services/order-edit.ts:808](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L808)
___ ___
@@ -463,7 +463,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:613](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L613) [medusa/src/services/order-edit.ts:613](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L613)
___ ___
@@ -484,7 +484,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:154](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L154) [medusa/src/services/order-edit.ts:154](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L154)
___ ___
@@ -505,7 +505,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:130](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L130) [medusa/src/services/order-edit.ts:130](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L130)
___ ___
@@ -527,7 +527,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L439) [medusa/src/services/order-edit.ts:439](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L439)
___ ___
@@ -548,7 +548,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L382) [medusa/src/services/order-edit.ts:382](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L382)
___ ___
@@ -570,7 +570,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:645](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L645) [medusa/src/services/order-edit.ts:645](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L645)
___ ___
@@ -591,7 +591,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:102](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L102) [medusa/src/services/order-edit.ts:102](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L102)
___ ___
@@ -612,7 +612,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:788](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L788) [medusa/src/services/order-edit.ts:788](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L788)
___ ___
@@ -636,7 +636,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -657,7 +657,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:211](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L211) [medusa/src/services/order-edit.ts:211](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L211)
___ ___
@@ -684,7 +684,7 @@ Create or update order edit item change line item and apply the quantity
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L309) [medusa/src/services/order-edit.ts:309](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L309)
___ ___
@@ -708,7 +708,7 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
___ ___
@@ -728,4 +728,4 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order-edit.ts:860](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order-edit.ts#L860) [medusa/src/services/order-edit.ts:860](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order-edit.ts#L860)
www/apps/docs/content/references/services/classes/OrderService.md
+70 -70
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new OrderService**(`__namedParameters`) • **new OrderService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/order.ts:137](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L137) [medusa/src/services/order.ts:137](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L137)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:128](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L128) [medusa/src/services/order.ts:128](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L128)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L127) [medusa/src/services/order.ts:127](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L127)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L115) [medusa/src/services/order.ts:115](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L115)
___ ___
@@ -106,7 +106,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L119) [medusa/src/services/order.ts:119](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L119)
___ ___
@@ -116,7 +116,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:130](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L130) [medusa/src/services/order.ts:130](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L130)
___ ___
@@ -126,7 +126,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:132](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L132) [medusa/src/services/order.ts:132](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L132)
___ ___
@@ -136,7 +136,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:133](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L133) [medusa/src/services/order.ts:133](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L133)
___ ___
@@ -146,7 +146,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L120) [medusa/src/services/order.ts:120](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L120)
___ ___
@@ -156,7 +156,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L121) [medusa/src/services/order.ts:121](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L121)
___ ___
@@ -166,7 +166,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L129) [medusa/src/services/order.ts:129](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L129)
___ ___
@@ -176,7 +176,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:131](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L131) [medusa/src/services/order.ts:131](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L131)
___ ___
@@ -186,7 +186,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L122) [medusa/src/services/order.ts:122](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L122)
___ ___
@@ -200,7 +200,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -210,7 +210,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L124) [medusa/src/services/order.ts:124](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L124)
___ ___
@@ -220,7 +220,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L114) [medusa/src/services/order.ts:114](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L114)
___ ___
@@ -230,7 +230,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L116) [medusa/src/services/order.ts:116](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L116)
___ ___
@@ -240,7 +240,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:135](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L135) [medusa/src/services/order.ts:135](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L135)
___ ___
@@ -250,7 +250,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:126](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L126) [medusa/src/services/order.ts:126](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L126)
___ ___
@@ -260,7 +260,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L117) [medusa/src/services/order.ts:117](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L117)
___ ___
@@ -270,7 +270,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L118) [medusa/src/services/order.ts:118](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L118)
___ ___
@@ -280,7 +280,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L125) [medusa/src/services/order.ts:125](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L125)
___ ___
@@ -290,7 +290,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L123) [medusa/src/services/order.ts:123](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L123)
___ ___
@@ -304,7 +304,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -335,7 +335,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L95) [medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L95)
## Accessors ## Accessors
@@ -353,7 +353,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -376,7 +376,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/services/order.ts:1024](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1024) [medusa/src/services/order.ts:1033](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1033)
___ ___
@@ -401,7 +401,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/order.ts:1556](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1556) [medusa/src/services/order.ts:1565](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1565)
___ ___
@@ -440,7 +440,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -466,7 +466,7 @@ result of the update operation.
#### Defined in #### Defined in
[medusa/src/services/order.ts:1174](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1174) [medusa/src/services/order.ts:1183](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1183)
___ ___
@@ -490,7 +490,7 @@ updated order
#### Defined in #### Defined in
[medusa/src/services/order.ts:1493](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1493) [medusa/src/services/order.ts:1502](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1502)
___ ___
@@ -514,7 +514,7 @@ result of the update operation.
#### Defined in #### Defined in
[medusa/src/services/order.ts:1263](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1263) [medusa/src/services/order.ts:1272](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1272)
___ ___
@@ -536,7 +536,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/order.ts:577](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L577) [medusa/src/services/order.ts:577](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L577)
___ ___
@@ -560,7 +560,7 @@ resolves to the creation result.
#### Defined in #### Defined in
[medusa/src/services/order.ts:607](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L607) [medusa/src/services/order.ts:607](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L607)
___ ___
@@ -592,7 +592,7 @@ result of the update operation.
#### Defined in #### Defined in
[medusa/src/services/order.ts:1368](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1368) [medusa/src/services/order.ts:1377](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1377)
___ ___
@@ -614,7 +614,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:804](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L804) [medusa/src/services/order.ts:814](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L814)
___ ___
@@ -643,7 +643,7 @@ the result of the refund operation.
#### Defined in #### Defined in
[medusa/src/services/order.ts:1582](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1582) [medusa/src/services/order.ts:1591](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1591)
___ ___
@@ -661,7 +661,7 @@ have been created in regards to the shipment.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `orderId` | `string` | the id of the order that has been shipped | | `orderId` | `string` | the id of the order that has been shipped |
| `fulfillmentId` | `string` | the fulfillment that has now been shipped | | `fulfillmentId` | `string` | the fulfillment that has now been shipped |
| `trackingLinks?` | `TrackingLink`[] | array of tracking numebers associated with the shipment | | `trackingLinks?` | `TrackingLink`[] | array of tracking numbers associated with the shipment |
| `config` | `Object` | the config of the order that has been shipped | | `config` | `Object` | the config of the order that has been shipped |
| `config.metadata` | `Record`<`string`, `unknown`\> | - | | `config.metadata` | `Record`<`string`, `unknown`\> | - |
| `config.no_notification?` | `boolean` | - | | `config.no_notification?` | `boolean` | - |
@@ -674,7 +674,7 @@ the resulting order following the update.
#### Defined in #### Defined in
[medusa/src/services/order.ts:858](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L858) [medusa/src/services/order.ts:867](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L867)
___ ___
@@ -697,7 +697,7 @@ Calculate and attach the different total fields on the object
#### Defined in #### Defined in
[medusa/src/services/order.ts:1779](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1779) [medusa/src/services/order.ts:1788](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1788)
▸ **decorateTotals**(`order`, `context?`): `Promise`<`Order`\> ▸ **decorateTotals**(`order`, `context?`): `Promise`<`Order`\>
@@ -716,7 +716,7 @@ Calculate and attach the different total fields on the object
#### Defined in #### Defined in
[medusa/src/services/order.ts:1781](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1781) [medusa/src/services/order.ts:1790](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1790)
___ ___
@@ -737,7 +737,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:1650](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1650) [medusa/src/services/order.ts:1659](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1659)
___ ___
@@ -753,7 +753,7 @@ Retrieves the order line items, given an array of items.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `order` | `Order` | the order to get line items from | | `order` | `Order` | the order to get line items from |
| `items` | `FulFillmentItemType`[] | the items to get | | `items` | `FulFillmentItemType`[] | the items to get |
| `transformer` | (`item`: `undefined` \| `LineItem`, `quantity`: `number`) => `unknown` | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. | | `transformer` | (`item`: `undefined` \| `LineItem`, `quantity`: `number`) => `unknown` | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. |
#### Returns #### Returns
@@ -763,7 +763,7 @@ the line items generated by the transformer.
#### Defined in #### Defined in
[medusa/src/services/order.ts:1535](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1535) [medusa/src/services/order.ts:1544](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1544)
___ ___
@@ -783,7 +783,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:2044](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L2044) [medusa/src/services/order.ts:2053](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L2053)
___ ___
@@ -806,7 +806,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/order.ts:189](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L189) [medusa/src/services/order.ts:189](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L189)
___ ___
@@ -829,7 +829,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/order.ts:206](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L206) [medusa/src/services/order.ts:206](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L206)
___ ___
@@ -840,8 +840,8 @@ ___
Handles receiving a return. This will create a Handles receiving a return. This will create a
refund to the customer. If the returned items don't match the requested refund to the customer. If the returned items don't match the requested
items the return status will be updated to requires_action. This behaviour items the return status will be updated to requires_action. This behaviour
is useful in sitautions where a custom refund amount is requested, but the is useful in situations where a custom refund amount is requested, but the
retuned items are not matching the requested items. Setting the returned items are not matching the requested items. Setting the
allowMismatch argument to true, will process the return, ignoring any allowMismatch argument to true, will process the return, ignoring any
mismatches. mismatches.
@@ -861,7 +861,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/order.ts:1969](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1969) [medusa/src/services/order.ts:1978](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1978)
___ ___
@@ -886,7 +886,7 @@ the order document
#### Defined in #### Defined in
[medusa/src/services/order.ts:388](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L388) [medusa/src/services/order.ts:388](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L388)
___ ___
@@ -911,7 +911,7 @@ the order document
#### Defined in #### Defined in
[medusa/src/services/order.ts:484](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L484) [medusa/src/services/order.ts:484](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L484)
___ ___
@@ -932,7 +932,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:518](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L518) [medusa/src/services/order.ts:518](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L518)
___ ___
@@ -957,7 +957,7 @@ the order document
#### Defined in #### Defined in
[medusa/src/services/order.ts:533](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L533) [medusa/src/services/order.ts:533](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L533)
___ ___
@@ -978,7 +978,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:428](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L428) [medusa/src/services/order.ts:428](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L428)
___ ___
@@ -1000,7 +1000,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:467](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L467) [medusa/src/services/order.ts:467](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L467)
___ ___
@@ -1024,7 +1024,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -1050,7 +1050,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/order.ts:312](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L312) [medusa/src/services/order.ts:312](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L312)
___ ___
@@ -1066,7 +1066,7 @@ will throw errors if metadata updates are attempted.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `orderId` | `string` | the id of the order. Must be a string that can be casted to an ObjectId | | `orderId` | `string` | the id of the order. Must be a string that can be casted to an ObjectId |
| `update` | `UpdateOrderInput` | an object with the update values. | | `update` | `UpdateOrderInput` | an object with the update values. |
#### Returns #### Returns
@@ -1077,7 +1077,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/order.ts:1085](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1085) [medusa/src/services/order.ts:1094](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1094)
___ ___
@@ -1102,7 +1102,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/order.ts:946](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L946) [medusa/src/services/order.ts:955](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L955)
___ ___
@@ -1127,7 +1127,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/order.ts:993](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L993) [medusa/src/services/order.ts:1002](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1002)
___ ___
@@ -1144,7 +1144,7 @@ quantity from the quantity that was originally purchased.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `item` | `LineItem` | the line item to check has sufficient fulfillable quantity. | | `item` | `LineItem` | the line item to check has sufficient fulfillable quantity. |
| `quantity` | `number` | the quantity that is requested to be fulfilled. | | `quantity` | `number` | the quantity that is requested to be fulfilled. |
#### Returns #### Returns
@@ -1156,7 +1156,7 @@ a line item that has the requested fulfillment quantity
#### Defined in #### Defined in
[medusa/src/services/order.ts:1335](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/order.ts#L1335) [medusa/src/services/order.ts:1344](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/order.ts#L1344)
___ ___
@@ -1180,4 +1180,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/PaymentCollectionService.md
+27 -27
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new PaymentCollectionService**(`__namedParameters`) • **new PaymentCollectionService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L46) [medusa/src/services/payment-collection.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L46)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L42) [medusa/src/services/payment-collection.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L42)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L40) [medusa/src/services/payment-collection.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L40)
___ ___
@@ -100,7 +100,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L44) [medusa/src/services/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L44)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:41](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L41) [medusa/src/services/payment-collection.ts:41](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L41)
___ ___
@@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -153,7 +153,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:33](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L33) [medusa/src/services/payment-collection.ts:33](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L33)
## Accessors ## Accessors
@@ -171,7 +171,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -210,7 +210,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -236,7 +236,7 @@ the payment collection and its payment session.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:528](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L528) [medusa/src/services/payment-collection.ts:528](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L528)
___ ___
@@ -260,7 +260,7 @@ the payment collection created.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:103](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L103) [medusa/src/services/payment-collection.ts:103](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L103)
___ ___
@@ -284,7 +284,7 @@ the payment collection removed.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:172](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L172) [medusa/src/services/payment-collection.ts:172](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L172)
___ ___
@@ -305,7 +305,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:210](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L210) [medusa/src/services/payment-collection.ts:210](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L210)
___ ___
@@ -329,7 +329,7 @@ the payment session authorized.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:499](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L499) [medusa/src/services/payment-collection.ts:499](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L499)
___ ___
@@ -355,7 +355,7 @@ the new payment session created.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:406](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L406) [medusa/src/services/payment-collection.ts:406](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L406)
___ ___
@@ -380,7 +380,7 @@ the payment collection.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L67) [medusa/src/services/payment-collection.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L67)
___ ___
@@ -406,7 +406,7 @@ the payment collection and its payment session.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:360](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L360) [medusa/src/services/payment-collection.ts:360](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L360)
___ ___
@@ -432,7 +432,7 @@ the payment collection and its payment sessions.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:225](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L225) [medusa/src/services/payment-collection.ts:225](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L225)
___ ___
@@ -456,7 +456,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -481,7 +481,7 @@ the payment collection updated.
#### Defined in #### Defined in
[medusa/src/services/payment-collection.ts:138](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-collection.ts#L138) [medusa/src/services/payment-collection.ts:138](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-collection.ts#L138)
___ ___
@@ -505,4 +505,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/PaymentProviderService.md
+47 -47
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:70](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L70) [medusa/src/services/payment-provider.ts:70](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L70)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L55) [medusa/src/services/payment-provider.ts:55](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L55)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L65) [medusa/src/services/payment-provider.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L65)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L68) [medusa/src/services/payment-provider.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L68)
___ ___
@@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:66](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L66) [medusa/src/services/payment-provider.ts:66](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L66)
___ ___
@@ -122,7 +122,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L58) [medusa/src/services/payment-provider.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L58)
___ ___
@@ -142,7 +142,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L59) [medusa/src/services/payment-provider.ts:59](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L59)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L56) [medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L56)
___ ___
@@ -162,7 +162,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L64) [medusa/src/services/payment-provider.ts:64](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L64)
___ ___
@@ -176,7 +176,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -194,7 +194,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
___ ___
@@ -208,7 +208,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L60) [medusa/src/services/payment-provider.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L60)
## Methods ## Methods
@@ -247,7 +247,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -268,7 +268,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:523](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L523) [medusa/src/services/payment-provider.ts:523](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L523)
___ ___
@@ -290,7 +290,7 @@ Build the create session context for both legacy and new API
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:845](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L845) [medusa/src/services/payment-provider.ts:845](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L845)
___ ___
@@ -310,7 +310,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:602](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L602) [medusa/src/services/payment-provider.ts:602](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L602)
___ ___
@@ -330,7 +330,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:641](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L641) [medusa/src/services/payment-provider.ts:641](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L641)
___ ___
@@ -350,7 +350,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:471](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L471) [medusa/src/services/payment-provider.ts:471](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L471)
___ ___
@@ -358,8 +358,6 @@ ___
▸ **createSession**(`providerId`, `cart`): `Promise`<`PaymentSession`\> ▸ **createSession**(`providerId`, `cart`): `Promise`<`PaymentSession`\>
**`Deprecated`**
#### Parameters #### Parameters
| Name | Type | | Name | Type |
@@ -371,9 +369,11 @@ ___
`Promise`<`PaymentSession`\> `Promise`<`PaymentSession`\>
**`Deprecated`**
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:205](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L205) [medusa/src/services/payment-provider.ts:205](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L205)
▸ **createSession**(`sessionInput`): `Promise`<`PaymentSession`\> ▸ **createSession**(`sessionInput`): `Promise`<`PaymentSession`\>
@@ -391,7 +391,7 @@ Creates a payment session with the given provider.
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:211](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L211) [medusa/src/services/payment-provider.ts:211](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L211)
___ ___
@@ -411,7 +411,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:402](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L402) [medusa/src/services/payment-provider.ts:402](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L402)
___ ___
@@ -431,7 +431,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:630](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L630) [medusa/src/services/payment-provider.ts:630](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L630)
___ ___
@@ -445,7 +445,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:102](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L102) [medusa/src/services/payment-provider.ts:102](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L102)
___ ___
@@ -468,7 +468,7 @@ List all the payments according to the given selector and config.
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:154](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L154) [medusa/src/services/payment-provider.ts:154](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L154)
___ ___
@@ -493,7 +493,7 @@ Process the collected data. Can be used every time we need to process some colle
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:935](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L935) [medusa/src/services/payment-provider.ts:935](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L935)
___ ___
@@ -508,7 +508,7 @@ This means, that we delete the current one and create a new.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `paymentSession` | `Object` | the payment session object to update | | `paymentSession` | `Object` | the payment session object to update |
| `paymentSession.data` | `Record`<`string`, `unknown`\> | - | | `paymentSession.data` | `Record`<`string`, `unknown`\> | - |
| `paymentSession.id` | `string` | - | | `paymentSession.id` | `string` | - |
| `paymentSession.provider_id` | `string` | - | | `paymentSession.provider_id` | `string` | - |
@@ -522,7 +522,7 @@ the payment session
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:301](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L301) [medusa/src/services/payment-provider.ts:301](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L301)
___ ___
@@ -545,7 +545,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:771](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L771) [medusa/src/services/payment-provider.ts:771](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L771)
___ ___
@@ -568,7 +568,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:672](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L672) [medusa/src/services/payment-provider.ts:672](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L672)
___ ___
@@ -588,7 +588,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:83](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L83) [medusa/src/services/payment-provider.ts:83](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L83)
___ ___
@@ -611,7 +611,7 @@ Retrieve a payment entity with the given id.
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:114](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L114) [medusa/src/services/payment-provider.ts:114](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L114)
___ ___
@@ -641,7 +641,7 @@ the payment provider
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:442](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L442) [medusa/src/services/payment-provider.ts:442](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L442)
___ ___
@@ -662,7 +662,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:822](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L822) [medusa/src/services/payment-provider.ts:822](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L822)
___ ___
@@ -685,7 +685,7 @@ Return the payment session for the given id.
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:172](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L172) [medusa/src/services/payment-provider.ts:172](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L172)
___ ___
@@ -715,7 +715,7 @@ Create or update a Payment session data.
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:887](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L887) [medusa/src/services/payment-provider.ts:887](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L887)
___ ___
@@ -739,7 +739,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -759,7 +759,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:954](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L954) [medusa/src/services/payment-provider.ts:954](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L954)
___ ___
@@ -782,7 +782,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:512](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L512) [medusa/src/services/payment-provider.ts:512](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L512)
___ ___
@@ -810,7 +810,7 @@ the payment session
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:342](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L342) [medusa/src/services/payment-provider.ts:342](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L342)
___ ___
@@ -831,7 +831,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment-provider.ts:569](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment-provider.ts#L569) [medusa/src/services/payment-provider.ts:569](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment-provider.ts#L569)
___ ___
@@ -855,4 +855,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/PaymentService.md
+21 -21
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new PaymentService**(`__namedParameters`) • **new PaymentService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/payment.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L39) [medusa/src/services/payment.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L39)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L27) [medusa/src/services/payment.ts:27](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L27)
___ ___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L28) [medusa/src/services/payment.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L28)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L29) [medusa/src/services/payment.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L29)
___ ___
@@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -145,7 +145,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L30) [medusa/src/services/payment.ts:30](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L30)
## Accessors ## Accessors
@@ -163,7 +163,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -202,7 +202,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -226,7 +226,7 @@ the payment captured.
#### Defined in #### Defined in
[medusa/src/services/payment.ts:153](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L153) [medusa/src/services/payment.ts:153](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L153)
___ ___
@@ -250,7 +250,7 @@ the payment created.
#### Defined in #### Defined in
[medusa/src/services/payment.ts:92](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L92) [medusa/src/services/payment.ts:92](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L92)
___ ___
@@ -277,7 +277,7 @@ the refund created.
#### Defined in #### Defined in
[medusa/src/services/payment.ts:202](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L202) [medusa/src/services/payment.ts:202](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L202)
___ ___
@@ -302,7 +302,7 @@ the payment.
#### Defined in #### Defined in
[medusa/src/services/payment.ts:58](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L58) [medusa/src/services/payment.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L58)
___ ___
@@ -326,7 +326,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -353,7 +353,7 @@ the payment updated.
#### Defined in #### Defined in
[medusa/src/services/payment.ts:121](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/payment.ts#L121) [medusa/src/services/payment.ts:121](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/payment.ts#L121)
___ ___
@@ -377,4 +377,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/PriceListService.md
+57 -37
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate product tags.
### constructor ### constructor
• **new PriceListService**(`__namedParameters`) • **new PriceListService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `PriceListConstructorProps` | | `«destructured»` | `PriceListConstructorProps` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L51) [medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L52)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L42) [medusa/src/services/price-list.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L43)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L49) [medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L50)
___ ___
@@ -102,27 +102,27 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### moneyAmountRepo\_ ### moneyAmountRepo\_
• `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`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing`: `boolean`) => `Promise`<[`Record`<`string`, `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`\> } • `Protected` `Readonly` **moneyAmountRepo\_**: `Repository`<`MoneyAmount`\> & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: `PriceListPriceCreateInput`[], `overrideExisting`: `boolean`) => `Promise`<`MoneyAmount`[]\> ; `createProductVariantMoneyAmounts`: (`toCreate`: { `money_amount_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<`InsertResult`\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: `ProductVariantPrice`[] ; `variantId`: `string` }[], `prices?`: `Price`[]) => `Promise`<`void`\> ; `findCurrencyMoneyAmounts`: (`where`: { `currency_code`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: `Currency` ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| `PriceList` ; `price_list_id`: ``null`` \| `string` ; `region?`: `Region` ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: `ProductVariant` ; `variant_id`: `any` ; `variants`: `ProductVariant`[] }[]\> ; `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`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing`: `boolean`) => `Promise`<[`Record`<`string`, `MoneyAmount`[]\>, `number`]\> ; `findRegionMoneyAmounts`: (`where`: { `region_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: `Currency` ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| `PriceList` ; `price_list_id`: ``null`` \| `string` ; `region?`: `Region` ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: `ProductVariant` ; `variant_id`: `any` ; `variants`: `ProductVariant`[] }[]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: `Price`[]) => `Promise`<`MoneyAmount`[]\> ; `getPricesForVariantInRegion`: (`variantId`: `string`, `regionId`: `undefined` \| `string`) => `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
[medusa/src/services/price-list.ts:47](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L47) [medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L48)
___ ___
### priceListRepo\_ ### priceListRepo\_
• `Protected` `Readonly` **priceListRepo\_**: `Repository`<`PriceList`\> & { `listAndCount`: (`query`: `ExtendedFindConfig`<`PriceList`\>, `q?`: `string`) => `Promise`<[`PriceList`[], `number`]\> } • `Protected` `Readonly` **priceListRepo\_**: `Repository`<`PriceList`\> & { `listAndCount`: (`query`: `ExtendedFindConfig`<`PriceList`\>, `q?`: `string`) => `Promise`<[`PriceList`[], `number`]\> ; `listPriceListsVariantIdsMap`: (`priceListIds`: `string` \| `string`[]) => `Promise`<{ `[priceListId: string]`: `string`[]; }\> }
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L46) [medusa/src/services/price-list.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L47)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:44](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L44) [medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L45)
___ ___
@@ -142,7 +142,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:48](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L48) [medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L49)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L43) [medusa/src/services/price-list.ts:44](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L44)
___ ___
@@ -166,7 +166,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -176,7 +176,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L45) [medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L46)
## Accessors ## Accessors
@@ -194,7 +194,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -224,7 +224,7 @@ updated `prices` list
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:492](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L492) [medusa/src/services/price-list.ts:524](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L524)
___ ___
@@ -250,7 +250,7 @@ updated Price List
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:212](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L212) [medusa/src/services/price-list.ts:242](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L242)
___ ___
@@ -289,7 +289,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -313,7 +313,7 @@ updated Price List
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:252](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L252) [medusa/src/services/price-list.ts:282](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L282)
___ ___
@@ -337,7 +337,7 @@ created Price List
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:113](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L113) [medusa/src/services/price-list.ts:143](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L143)
___ ___
@@ -362,7 +362,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:266](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L266) [medusa/src/services/price-list.ts:296](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L296)
___ ___
@@ -387,7 +387,7 @@ updated Price List
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:237](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L237) [medusa/src/services/price-list.ts:267](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L267)
___ ___
@@ -408,7 +408,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:419](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L419) [medusa/src/services/price-list.ts:451](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L451)
___ ___
@@ -429,7 +429,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:456](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L456) [medusa/src/services/price-list.ts:488](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L488)
___ ___
@@ -454,7 +454,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:286](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L286) [medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L316)
___ ___
@@ -479,7 +479,27 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:300](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L300) [medusa/src/services/price-list.ts:330](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L330)
___
### listPriceListsVariantIdsMap
▸ **listPriceListsVariantIdsMap**(`priceListIds`): `Promise`<{ `[priceListId: string]`: `string`[]; }\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `priceListIds` | `string` \| `string`[] |
#### Returns
`Promise`<{ `[priceListId: string]`: `string`[]; }\>
#### Defined in
[medusa/src/services/price-list.ts:109](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L109)
___ ___
@@ -502,7 +522,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:337](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L337) [medusa/src/services/price-list.ts:367](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L367)
___ ___
@@ -525,7 +545,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:385](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L385) [medusa/src/services/price-list.ts:417](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L417)
___ ___
@@ -550,7 +570,7 @@ the collection.
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:80](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L80) [medusa/src/services/price-list.ts:81](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L81)
___ ___
@@ -574,7 +594,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -599,7 +619,7 @@ updated Price List
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:161](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L161) [medusa/src/services/price-list.ts:191](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L191)
___ ___
@@ -620,7 +640,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/price-list.ts:316](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/price-list.ts#L316) [medusa/src/services/price-list.ts:346](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/price-list.ts#L346)
___ ___
@@ -644,4 +664,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/PricingService.md
+34 -34
View File
@@ -12,13 +12,13 @@ Allows retrieval of prices.
### constructor ### constructor
• **new PricingService**(`__namedParameters`) • **new PricingService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L42) [medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L42)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L40) [medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L40)
___ ___
@@ -92,7 +92,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -102,7 +102,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L38) [medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L38)
___ ___
@@ -112,7 +112,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L39) [medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L39)
___ ___
@@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L36) [medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L36)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L37) [medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L37)
___ ___
@@ -146,7 +146,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -164,7 +164,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -203,7 +203,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -228,7 +228,7 @@ The tax related variant prices.
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:101](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L101) [medusa/src/services/pricing.ts:101](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L101)
___ ___
@@ -253,7 +253,7 @@ The pricing context
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L65) [medusa/src/services/pricing.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L65)
___ ___
@@ -279,7 +279,7 @@ A map of variant ids to their corresponding prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:419](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L419) [medusa/src/services/pricing.ts:419](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L419)
___ ___
@@ -304,7 +304,7 @@ A map of variant ids to their corresponding prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:437](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L437) [medusa/src/services/pricing.ts:437](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L437)
___ ___
@@ -325,7 +325,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:362](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L362) [medusa/src/services/pricing.ts:362](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L362)
___ ___
@@ -350,7 +350,7 @@ The product variant prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:216](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L216) [medusa/src/services/pricing.ts:216](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L216)
___ ___
@@ -360,10 +360,6 @@ ___
Gets the prices for a product variant by a variant id. Gets the prices for a product variant by a variant id.
**`Deprecated`**
Use [getProductVariantsPricing](PricingService.md#getproductvariantspricing) instead.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -377,9 +373,13 @@ Use [getProductVariantsPricing](PricingService.md#getproductvariantspricing) ins
The product variant prices The product variant prices
**`Deprecated`**
Use [getProductVariantsPricing](PricingService.md#getproductvariantspricing) instead.
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:265](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L265) [medusa/src/services/pricing.ts:265](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L265)
___ ___
@@ -400,7 +400,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:163](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L163) [medusa/src/services/pricing.ts:163](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L163)
___ ___
@@ -425,7 +425,7 @@ The product variant prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:310](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L310) [medusa/src/services/pricing.ts:310](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L310)
___ ___
@@ -450,7 +450,7 @@ The shipping option prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:526](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L526) [medusa/src/services/pricing.ts:526](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L526)
___ ___
@@ -475,7 +475,7 @@ A list of products with variants decorated with prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:486](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L486) [medusa/src/services/pricing.ts:486](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L486)
___ ___
@@ -500,7 +500,7 @@ A list of shipping options with prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:588](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L588) [medusa/src/services/pricing.ts:588](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L588)
___ ___
@@ -525,7 +525,7 @@ A list of products with variants decorated with prices
#### Defined in #### Defined in
[medusa/src/services/pricing.ts:459](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/pricing.ts#L459) [medusa/src/services/pricing.ts:459](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/pricing.ts#L459)
___ ___
@@ -549,7 +549,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -573,4 +573,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ProductCategoryService.md
+28 -28
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate product categories.
### constructor ### constructor
• **new ProductCategoryService**(`__namedParameters`) • **new ProductCategoryService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L40) [medusa/src/services/product-category.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L40)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:32](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L32) [medusa/src/services/product-category.ts:32](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L32)
___ ___
@@ -92,7 +92,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -102,7 +102,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:31](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L31) [medusa/src/services/product-category.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L31)
___ ___
@@ -116,7 +116,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -134,7 +134,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L34) [medusa/src/services/product-category.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L34)
## Accessors ## Accessors
@@ -152,7 +152,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -177,7 +177,7 @@ the product category on which the products have been added
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:314](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L314) [medusa/src/services/product-category.ts:314](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L314)
___ ___
@@ -216,7 +216,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -240,7 +240,7 @@ created product category
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:187](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L187) [medusa/src/services/product-category.ts:187](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L187)
___ ___
@@ -264,7 +264,7 @@ a promise
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:268](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L268) [medusa/src/services/product-category.ts:268](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L268)
___ ___
@@ -286,7 +286,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:349](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L349) [medusa/src/services/product-category.ts:349](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L349)
___ ___
@@ -315,7 +315,7 @@ an array containing the product category as
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:61](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L61) [medusa/src/services/product-category.ts:61](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L61)
___ ___
@@ -336,7 +336,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:377](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L377) [medusa/src/services/product-category.ts:377](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L377)
___ ___
@@ -361,7 +361,7 @@ the product category on which the products have been removed
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:333](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L333) [medusa/src/services/product-category.ts:333](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L333)
___ ___
@@ -388,7 +388,7 @@ the product category.
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:139](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L139) [medusa/src/services/product-category.ts:139](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L139)
___ ___
@@ -415,7 +415,7 @@ the product category.
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:165](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L165) [medusa/src/services/product-category.ts:165](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L165)
___ ___
@@ -441,7 +441,7 @@ the product category.
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:102](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L102) [medusa/src/services/product-category.ts:102](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L102)
___ ___
@@ -462,7 +462,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:415](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L415) [medusa/src/services/product-category.ts:415](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L415)
___ ___
@@ -486,7 +486,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -511,7 +511,7 @@ transformed productCategoryInput
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:513](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L513) [medusa/src/services/product-category.ts:513](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L513)
___ ___
@@ -536,7 +536,7 @@ updated product category
#### Defined in #### Defined in
[medusa/src/services/product-category.ts:221](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-category.ts#L221) [medusa/src/services/product-category.ts:221](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-category.ts#L221)
___ ___
@@ -560,4 +560,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ProductCollectionService.md
+26 -26
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate product collections.
### constructor ### constructor
• **new ProductCollectionService**(`__namedParameters`) • **new ProductCollectionService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:49](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L49) [medusa/src/services/product-collection.ts:49](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L49)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:36](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L36) [medusa/src/services/product-collection.ts:36](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L36)
___ ___
@@ -92,7 +92,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -102,17 +102,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:38](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L38) [medusa/src/services/product-collection.ts:38](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L38)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> } • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: `CategoryQueryParams`, `includeCategoryChildren`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: `ProductCategory`) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L39) [medusa/src/services/product-collection.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L39)
___ ___
@@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -146,7 +146,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:41](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L41) [medusa/src/services/product-collection.ts:41](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L41)
## Accessors ## Accessors
@@ -164,7 +164,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -185,7 +185,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:216](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L216) [medusa/src/services/product-collection.ts:216](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L216)
___ ___
@@ -224,7 +224,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -248,7 +248,7 @@ created collection
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:128](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L128) [medusa/src/services/product-collection.ts:128](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L128)
___ ___
@@ -272,7 +272,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:192](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L192) [medusa/src/services/product-collection.ts:192](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L192)
___ ___
@@ -299,7 +299,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:274](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L274) [medusa/src/services/product-collection.ts:274](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L274)
___ ___
@@ -324,7 +324,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:291](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L291) [medusa/src/services/product-collection.ts:291](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L291)
___ ___
@@ -345,7 +345,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:242](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L242) [medusa/src/services/product-collection.ts:242](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L242)
___ ___
@@ -370,7 +370,7 @@ the collection.
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L68) [medusa/src/services/product-collection.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L68)
___ ___
@@ -395,7 +395,7 @@ the collection.
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:102](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L102) [medusa/src/services/product-collection.ts:102](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L102)
___ ___
@@ -419,7 +419,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -444,7 +444,7 @@ update collection
#### Defined in #### Defined in
[medusa/src/services/product-collection.ts:154](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-collection.ts#L154) [medusa/src/services/product-collection.ts:154](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-collection.ts#L154)
___ ___
@@ -468,4 +468,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ProductService.md
+56 -56
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ProductService**(`__namedParameters`) • **new ProductService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/product.ts:80](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L80) [medusa/src/services/product.ts:78](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L78)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:70](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L70) [medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L68)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L71) [medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L69)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L65) [medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L63)
___ ___
@@ -110,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L67) [medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L65)
___ ___
@@ -130,17 +130,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L60) [medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L58)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> } • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: `CategoryQueryParams`, `includeCategoryChildren`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: `ProductCategory`) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L61) [medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L59)
___ ___
@@ -150,7 +150,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L64) [medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L62)
___ ___
@@ -160,7 +160,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L63) [medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L61)
___ ___
@@ -170,7 +170,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L62) [medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L60)
___ ___
@@ -180,7 +180,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L68) [medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L66)
___ ___
@@ -190,7 +190,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L69) [medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L67)
___ ___
@@ -204,7 +204,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -222,7 +222,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:74](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L74) [medusa/src/services/product.ts:72](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L72)
___ ___
@@ -232,7 +232,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L73) [medusa/src/services/product.ts:71](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L71)
## Accessors ## Accessors
@@ -250,7 +250,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -277,7 +277,7 @@ the result of the model update operation
#### Defined in #### Defined in
[medusa/src/services/product.ts:699](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L699) [medusa/src/services/product.ts:697](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L697)
___ ___
@@ -316,7 +316,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -340,7 +340,7 @@ the result of the count operation
#### Defined in #### Defined in
[medusa/src/services/product.ts:186](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L186) [medusa/src/services/product.ts:184](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L184)
___ ___
@@ -364,7 +364,7 @@ resolves to the creation result.
#### Defined in #### Defined in
[medusa/src/services/product.ts:419](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L419) [medusa/src/services/product.ts:417](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L417)
___ ___
@@ -379,7 +379,7 @@ variants will also be deleted.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `productId` | `string` | the id of the product to delete. Must be castable as an ObjectId | | `productId` | `string` | the id of the product to delete. Must be castable as an ObjectId |
#### Returns #### Returns
@@ -389,7 +389,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/product.ts:660](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L660) [medusa/src/services/product.ts:658](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L658)
___ ___
@@ -414,7 +414,7 @@ the updated product
#### Defined in #### Defined in
[medusa/src/services/product.ts:864](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L864) [medusa/src/services/product.ts:862](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L862)
___ ___
@@ -436,7 +436,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:344](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L344) [medusa/src/services/product.ts:342](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L342)
___ ___
@@ -459,7 +459,7 @@ Check if the product is assigned to at least one of the provided sales channels.
#### Defined in #### Defined in
[medusa/src/services/product.ts:397](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L397) [medusa/src/services/product.ts:395](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L395)
___ ___
@@ -473,8 +473,8 @@ Lists products based on the provided parameters.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `ProductSelector` | an object that defines rules to filter products by | | `selector` | `ProductSelector` | an object that defines rules to filter products by |
| `config` | `FindProductConfig` | object that defines the scope for what should be returned | | `config` | `FindProductConfig` | object that defines the scope for what should be returned |
#### Returns #### Returns
@@ -484,7 +484,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/product.ts:117](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L117) [medusa/src/services/product.ts:115](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L115)
___ ___
@@ -499,8 +499,8 @@ products that match the query.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `ProductSelector` | an object that defines rules to filter products by | | `selector` | `ProductSelector` | an object that defines rules to filter products by |
| `config` | `FindProductConfig` | object that defines the scope for what should be returned | | `config` | `FindProductConfig` | object that defines the scope for what should be returned |
#### Returns #### Returns
@@ -512,7 +512,7 @@ an array containing the products as
#### Defined in #### Defined in
[medusa/src/services/product.ts:141](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L141) [medusa/src/services/product.ts:139](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L139)
___ ___
@@ -532,7 +532,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:383](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L383) [medusa/src/services/product.ts:381](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L381)
___ ___
@@ -546,7 +546,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:375](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L375) [medusa/src/services/product.ts:373](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L373)
___ ___
@@ -575,7 +575,7 @@ Temporary method to be used in place we need custom query strategy to prevent ty
#### Defined in #### Defined in
[medusa/src/services/product.ts:972](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L972) [medusa/src/services/product.ts:970](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L970)
___ ___
@@ -596,7 +596,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product.ts:742](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L742) [medusa/src/services/product.ts:740](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L740)
___ ___
@@ -612,7 +612,7 @@ Throws in case of DB Error and if product was not found.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `productId` | `string` | id of the product to get. | | `productId` | `string` | id of the product to get. |
| `config` | `FindProductConfig` | object that defines what should be included in the query response | | `config` | `FindProductConfig` | object that defines what should be included in the query response |
#### Returns #### Returns
@@ -622,7 +622,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[medusa/src/services/product.ts:202](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L202) [medusa/src/services/product.ts:200](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L200)
___ ___
@@ -648,7 +648,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[medusa/src/services/product.ts:246](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L246) [medusa/src/services/product.ts:244](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L244)
___ ___
@@ -674,7 +674,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[medusa/src/services/product.ts:225](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L225) [medusa/src/services/product.ts:223](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L223)
___ ___
@@ -699,7 +699,7 @@ product option
#### Defined in #### Defined in
[medusa/src/services/product.ts:845](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L845) [medusa/src/services/product.ts:843](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L843)
___ ___
@@ -724,7 +724,7 @@ an array of variants
#### Defined in #### Defined in
[medusa/src/services/product.ts:326](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L326) [medusa/src/services/product.ts:324](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L324)
___ ___
@@ -740,7 +740,7 @@ Throws in case of DB Error and if product was not found.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> | selector object | | `selector` | `Selector`<`Product`\> | selector object |
| `config` | `FindProductConfig` | object that defines what should be included in the query response | | `config` | `FindProductConfig` | object that defines what should be included in the query response |
#### Returns #### Returns
@@ -750,7 +750,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[medusa/src/services/product.ts:268](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L268) [medusa/src/services/product.ts:266](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L266)
___ ___
@@ -774,7 +774,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -790,7 +790,7 @@ product variant updates are attempted.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `productId` | `string` | the id of the product. Must be a string that can be casted to an ObjectId | | `productId` | `string` | the id of the product. Must be a string that can be casted to an ObjectId |
| `update` | `UpdateProductInput` | an object with the update values. | | `update` | `UpdateProductInput` | an object with the update values. |
#### Returns #### Returns
@@ -801,7 +801,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/product.ts:528](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L528) [medusa/src/services/product.ts:526](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L526)
___ ___
@@ -828,7 +828,7 @@ the updated product
#### Defined in #### Defined in
[medusa/src/services/product.ts:788](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L788) [medusa/src/services/product.ts:786](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L786)
___ ___
@@ -853,7 +853,7 @@ updated products
#### Defined in #### Defined in
[medusa/src/services/product.ts:935](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product.ts#L935) [medusa/src/services/product.ts:933](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product.ts#L933)
___ ___
@@ -877,4 +877,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ProductTypeService.md
+17 -17
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ProductTypeService**(`__namedParameters`) • **new ProductTypeService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/product-type.ts:12](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-type.ts#L12) [medusa/src/services/product-type.ts:12](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-type.ts#L12)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -94,7 +94,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-type.ts#L10) [medusa/src/services/product-type.ts:10](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-type.ts#L10)
## Accessors ## Accessors
@@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -161,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -186,7 +186,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/product-type.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-type.ts#L52) [medusa/src/services/product-type.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-type.ts#L52)
___ ___
@@ -211,7 +211,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/product-type.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-type.ts#L69) [medusa/src/services/product-type.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-type.ts#L69)
___ ___
@@ -227,7 +227,7 @@ Throws in case of DB Error and if product was not found.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the product to get. | | `id` | `string` | id of the product to get. |
| `config` | `FindConfig`<`ProductType`\> | object that defines what should be included in the query response | | `config` | `FindConfig`<`ProductType`\> | object that defines what should be included in the query response |
#### Returns #### Returns
@@ -237,7 +237,7 @@ the result of the find one operation.
#### Defined in #### Defined in
[medusa/src/services/product-type.ts:27](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-type.ts#L27) [medusa/src/services/product-type.ts:27](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-type.ts#L27)
___ ___
@@ -261,7 +261,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -285,4 +285,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ProductVariantInventoryService.md
+37 -37
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ProductVariantInventoryService**(`__namedParameters`) • **new ProductVariantInventoryService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:50](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L50) [medusa/src/services/product-variant-inventory.ts:50](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L50)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:48](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L48) [medusa/src/services/product-variant-inventory.ts:48](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L48)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:47](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L47) [medusa/src/services/product-variant-inventory.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L47)
___ ___
@@ -96,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L46) [medusa/src/services/product-variant-inventory.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L46)
___ ___
@@ -110,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L39) [medusa/src/services/product-variant-inventory.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L39)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:44](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L44) [medusa/src/services/product-variant-inventory.ts:44](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L44)
___ ___
@@ -130,7 +130,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L43) [medusa/src/services/product-variant-inventory.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L43)
___ ___
@@ -140,7 +140,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L42) [medusa/src/services/product-variant-inventory.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L42)
___ ___
@@ -150,7 +150,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L45) [medusa/src/services/product-variant-inventory.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L45)
___ ___
@@ -164,7 +164,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L40) [medusa/src/services/product-variant-inventory.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L40)
## Accessors ## Accessors
@@ -182,7 +182,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -206,7 +206,7 @@ Adjusts inventory of a variant on a location
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:740](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L740) [medusa/src/services/product-variant-inventory.ts:740](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L740)
___ ___
@@ -231,7 +231,7 @@ Adjusts the quantity of reservations for a line item by a given amount.
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:530](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L530) [medusa/src/services/product-variant-inventory.ts:530](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L530)
___ ___
@@ -270,7 +270,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -294,7 +294,7 @@ the variant inventory item
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:257](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L257) [medusa/src/services/product-variant-inventory.ts:257](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L257)
▸ **attachInventoryItem**(`variantId`, `inventoryItemId`, `requiredQuantity?`): `Promise`<`ProductVariantInventoryItem`[]\> ▸ **attachInventoryItem**(`variantId`, `inventoryItemId`, `requiredQuantity?`): `Promise`<`ProductVariantInventoryItem`[]\>
@@ -312,7 +312,7 @@ the variant inventory item
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:264](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L264) [medusa/src/services/product-variant-inventory.ts:264](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L264)
___ ___
@@ -339,7 +339,7 @@ boolean indicating if inventory is available
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:76](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L76) [medusa/src/services/product-variant-inventory.ts:76](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L76)
___ ___
@@ -363,7 +363,7 @@ delete a reservation of variant quantity
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:705](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L705) [medusa/src/services/product-variant-inventory.ts:705](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L705)
___ ___
@@ -386,7 +386,7 @@ Remove a variant from an inventory item
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:409](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L409) [medusa/src/services/product-variant-inventory.ts:409](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L409)
___ ___
@@ -408,7 +408,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:843](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L843) [medusa/src/services/product-variant-inventory.ts:843](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L843)
___ ___
@@ -436,7 +436,7 @@ The available quantity of the variant from the inventoryItems
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:954](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L954) [medusa/src/services/product-variant-inventory.ts:954](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L954)
___ ___
@@ -460,7 +460,7 @@ list of inventory items
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:179](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L179) [medusa/src/services/product-variant-inventory.ts:179](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L179)
___ ___
@@ -484,7 +484,7 @@ variant inventory items for the variant id
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:196](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L196) [medusa/src/services/product-variant-inventory.ts:196](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L196)
___ ___
@@ -508,7 +508,7 @@ lidt of inventory items for the variant
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:235](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L235) [medusa/src/services/product-variant-inventory.ts:235](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L235)
___ ___
@@ -532,7 +532,7 @@ a list of product variants that are associated with the item id
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:217](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L217) [medusa/src/services/product-variant-inventory.ts:217](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L217)
___ ___
@@ -556,7 +556,7 @@ Reserves a quantity of a variant
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:439](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L439) [medusa/src/services/product-variant-inventory.ts:439](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L439)
___ ___
@@ -581,7 +581,7 @@ A promise that resolves with the product variant inventory item.
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:152](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L152) [medusa/src/services/product-variant-inventory.ts:152](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L152)
___ ___
@@ -602,7 +602,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:910](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L910) [medusa/src/services/product-variant-inventory.ts:910](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L910)
___ ___
@@ -624,7 +624,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:784](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L784) [medusa/src/services/product-variant-inventory.ts:784](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L784)
___ ___
@@ -648,7 +648,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -673,7 +673,7 @@ nothing if successful, throws error if not
#### Defined in #### Defined in
[medusa/src/services/product-variant-inventory.ts:640](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant-inventory.ts#L640) [medusa/src/services/product-variant-inventory.ts:640](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant-inventory.ts#L640)
___ ___
@@ -697,4 +697,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ProductVariantService.md
+58 -58
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ProductVariantService**(`__namedParameters`) • **new ProductVariantService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:75](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L75) [medusa/src/services/product-variant.ts:74](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L74)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:73](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L73) [medusa/src/services/product-variant.ts:72](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L72)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L67) [medusa/src/services/product-variant.ts:66](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L66)
___ ___
@@ -100,17 +100,17 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### moneyAmountRepository\_ ### 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`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing`: `boolean`) => `Promise`<[`Record`<`string`, `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`\> } • `Protected` `Readonly` **moneyAmountRepository\_**: `Repository`<`MoneyAmount`\> & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: `PriceListPriceCreateInput`[], `overrideExisting`: `boolean`) => `Promise`<`MoneyAmount`[]\> ; `createProductVariantMoneyAmounts`: (`toCreate`: { `money_amount_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<`InsertResult`\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: `ProductVariantPrice`[] ; `variantId`: `string` }[], `prices?`: `Price`[]) => `Promise`<`void`\> ; `findCurrencyMoneyAmounts`: (`where`: { `currency_code`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: `Currency` ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| `PriceList` ; `price_list_id`: ``null`` \| `string` ; `region?`: `Region` ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: `ProductVariant` ; `variant_id`: `any` ; `variants`: `ProductVariant`[] }[]\> ; `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`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing`: `boolean`) => `Promise`<[`Record`<`string`, `MoneyAmount`[]\>, `number`]\> ; `findRegionMoneyAmounts`: (`where`: { `region_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: `Currency` ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| `PriceList` ; `price_list_id`: ``null`` \| `string` ; `region?`: `Region` ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: `ProductVariant` ; `variant_id`: `any` ; `variants`: `ProductVariant`[] }[]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: `Price`[]) => `Promise`<`MoneyAmount`[]\> ; `getPricesForVariantInRegion`: (`variantId`: `string`, `regionId`: `undefined` \| `string`) => `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
[medusa/src/services/product-variant.ts:70](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L70) [medusa/src/services/product-variant.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L69)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L69) [medusa/src/services/product-variant.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L68)
___ ___
@@ -130,17 +130,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:72](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L72) [medusa/src/services/product-variant.ts:71](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L71)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> } • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: `CategoryQueryParams`, `includeCategoryChildren`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: `ProductCategory`) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:66](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L66) [medusa/src/services/product-variant.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L65)
___ ___
@@ -150,7 +150,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L65) [medusa/src/services/product-variant.ts:64](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L64)
___ ___
@@ -160,7 +160,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L68) [medusa/src/services/product-variant.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L67)
___ ___
@@ -174,7 +174,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -192,7 +192,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:59](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L59) [medusa/src/services/product-variant.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L58)
## Accessors ## Accessors
@@ -210,7 +210,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -240,7 +240,7 @@ the result of the update operation.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:836](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L836) [medusa/src/services/product-variant.ts:843](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L843)
___ ___
@@ -279,7 +279,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -312,7 +312,7 @@ resolves to the creation result.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:168](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L168) [medusa/src/services/product-variant.ts:167](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L167)
___ ___
@@ -327,7 +327,7 @@ Will never fail due to delete being idempotent.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `variantIds` | `string` \| `string`[] | the id of the variant to delete. Must be castable as an ObjectId | | `variantIds` | `string` \| `string`[] | the id of the variant to delete. Must be castable as an ObjectId |
#### Returns #### Returns
@@ -337,7 +337,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:1006](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L1006) [medusa/src/services/product-variant.ts:1013](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L1013)
___ ___
@@ -363,7 +363,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:863](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L863) [medusa/src/services/product-variant.ts:870](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L870)
___ ___
@@ -391,7 +391,7 @@ an array containing the products as the first element and the total
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:1069](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L1069) [medusa/src/services/product-variant.ts:1076](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L1076)
___ ___
@@ -418,7 +418,7 @@ the price specific to the region
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:711](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L711) [medusa/src/services/product-variant.ts:708](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L708)
___ ___
@@ -441,7 +441,7 @@ Check if the variant is assigned to at least one of the provided sales channels.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:1044](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L1044) [medusa/src/services/product-variant.ts:1051](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L1051)
___ ___
@@ -464,7 +464,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:952](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L952) [medusa/src/services/product-variant.ts:959](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L959)
___ ___
@@ -487,7 +487,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:891](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L891) [medusa/src/services/product-variant.ts:898](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L898)
___ ___
@@ -512,7 +512,7 @@ the product document.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:104](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L104) [medusa/src/services/product-variant.ts:103](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L103)
___ ___
@@ -537,7 +537,7 @@ the product document.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:132](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L132) [medusa/src/services/product-variant.ts:131](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L131)
___ ___
@@ -545,11 +545,6 @@ ___
▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\> ▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\>
**`Deprecated`**
use addOrUpdateCurrencyPrices instead
Sets the default price for the given currency.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -563,9 +558,14 @@ Sets the default price for the given currency.
the result of the update operation the result of the update operation
**`Deprecated`**
use addOrUpdateCurrencyPrices instead
Sets the default price for the given currency.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:777](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L777) [medusa/src/services/product-variant.ts:784](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L784)
___ ___
@@ -573,11 +573,6 @@ ___
▸ **setRegionPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\> ▸ **setRegionPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\>
**`Deprecated`**
use addOrUpdateRegionPrices instead
Sets the default price of a specific region
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -591,9 +586,14 @@ Sets the default price of a specific region
the result of the update operation the result of the update operation
**`Deprecated`**
use addOrUpdateRegionPrices instead
Sets the default price of a specific region
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:740](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L740) [medusa/src/services/product-variant.ts:737](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L737)
___ ___
@@ -617,7 +617,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -641,7 +641,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:266](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L266) [medusa/src/services/product-variant.ts:265](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L265)
▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\> ▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\>
@@ -664,7 +664,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:281](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L281) [medusa/src/services/product-variant.ts:280](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L280)
▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\> ▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\>
@@ -681,7 +681,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:286](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L286) [medusa/src/services/product-variant.ts:285](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L285)
___ ___
@@ -701,7 +701,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:340](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L340) [medusa/src/services/product-variant.ts:339](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L339)
___ ___
@@ -728,7 +728,7 @@ the result of the update operation.
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:798](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L798) [medusa/src/services/product-variant.ts:805](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L805)
___ ___
@@ -753,7 +753,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:438](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L438) [medusa/src/services/product-variant.ts:438](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L438)
▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\> ▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\>
@@ -775,7 +775,7 @@ empty promise
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:447](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L447) [medusa/src/services/product-variant.ts:447](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L447)
___ ___
@@ -795,7 +795,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:467](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L467) [medusa/src/services/product-variant.ts:467](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L467)
___ ___
@@ -815,7 +815,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:619](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L619) [medusa/src/services/product-variant.ts:618](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L618)
___ ___
@@ -835,7 +835,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:540](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L540) [medusa/src/services/product-variant.ts:540](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L540)
___ ___
@@ -856,7 +856,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/product-variant.ts:1104](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/product-variant.ts#L1104) [medusa/src/services/product-variant.ts:1111](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/product-variant.ts#L1111)
___ ___
@@ -880,4 +880,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/RegionService.md
+50 -50
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate regions.
### constructor ### constructor
• **new RegionService**(`__namedParameters`) • **new RegionService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L64) [medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L64)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L56) [medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L56)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L57) [medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L57)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L51) [medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L51)
___ ___
@@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:49](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L49) [medusa/src/services/region.ts:49](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L49)
___ ___
@@ -118,7 +118,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:61](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L61) [medusa/src/services/region.ts:61](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L61)
___ ___
@@ -128,7 +128,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L54) [medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L54)
___ ___
@@ -142,7 +142,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L59) [medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L59)
___ ___
@@ -162,7 +162,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L53) [medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L53)
___ ___
@@ -172,7 +172,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L55) [medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L55)
___ ___
@@ -182,7 +182,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L52) [medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L52)
___ ___
@@ -192,7 +192,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L62) [medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L62)
___ ___
@@ -206,7 +206,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -224,7 +224,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/region.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L43) [medusa/src/services/region.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L43)
## Accessors ## Accessors
@@ -242,7 +242,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -267,7 +267,7 @@ the updated Region
#### Defined in #### Defined in
[medusa/src/services/region.ts:577](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L577) [medusa/src/services/region.ts:577](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L577)
___ ___
@@ -293,7 +293,7 @@ the updated Region
#### Defined in #### Defined in
[medusa/src/services/region.ts:705](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L705) [medusa/src/services/region.ts:705](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L705)
___ ___
@@ -319,7 +319,7 @@ the updated Region
#### Defined in #### Defined in
[medusa/src/services/region.ts:656](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L656) [medusa/src/services/region.ts:656](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L656)
___ ___
@@ -358,7 +358,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -382,7 +382,7 @@ the newly created region
#### Defined in #### Defined in
[medusa/src/services/region.ts:100](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L100) [medusa/src/services/region.ts:100](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L100)
___ ___
@@ -406,7 +406,7 @@ the result of the delete operation
#### Defined in #### Defined in
[medusa/src/services/region.ts:546](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L546) [medusa/src/services/region.ts:546](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L546)
___ ___
@@ -431,7 +431,7 @@ result of the find operation
#### Defined in #### Defined in
[medusa/src/services/region.ts:505](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L505) [medusa/src/services/region.ts:505](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L505)
___ ___
@@ -456,7 +456,7 @@ result of the find operation
#### Defined in #### Defined in
[medusa/src/services/region.ts:524](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L524) [medusa/src/services/region.ts:524](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L524)
___ ___
@@ -481,7 +481,7 @@ the updated Region
#### Defined in #### Defined in
[medusa/src/services/region.ts:615](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L615) [medusa/src/services/region.ts:615](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L615)
___ ___
@@ -506,7 +506,7 @@ the updated Region
#### Defined in #### Defined in
[medusa/src/services/region.ts:791](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L791) [medusa/src/services/region.ts:791](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L791)
___ ___
@@ -531,7 +531,7 @@ the updated Region
#### Defined in #### Defined in
[medusa/src/services/region.ts:752](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L752) [medusa/src/services/region.ts:752](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L752)
___ ___
@@ -556,7 +556,7 @@ the region
#### Defined in #### Defined in
[medusa/src/services/region.ts:470](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L470) [medusa/src/services/region.ts:470](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L470)
___ ___
@@ -581,7 +581,7 @@ a Region with country code
#### Defined in #### Defined in
[medusa/src/services/region.ts:416](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L416) [medusa/src/services/region.ts:416](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L416)
___ ___
@@ -605,7 +605,7 @@ region with the matching name
#### Defined in #### Defined in
[medusa/src/services/region.ts:450](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L450) [medusa/src/services/region.ts:450](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L450)
___ ___
@@ -629,7 +629,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -654,7 +654,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/region.ts:171](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L171) [medusa/src/services/region.ts:171](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L171)
___ ___
@@ -680,7 +680,7 @@ the validated Country
#### Defined in #### Defined in
[medusa/src/services/region.ts:367](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L367) [medusa/src/services/region.ts:367](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L367)
___ ___
@@ -690,10 +690,6 @@ ___
Validates a currency code. Will throw if the currency code doesn't exist. Validates a currency code. Will throw if the currency code doesn't exist.
**`Throws`**
if the provided currency code is invalid
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -706,9 +702,13 @@ if the provided currency code is invalid
void void
**`Throws`**
if the provided currency code is invalid
#### Defined in #### Defined in
[medusa/src/services/region.ts:342](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L342) [medusa/src/services/region.ts:342](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L342)
___ ___
@@ -740,7 +740,7 @@ the validated region data
#### Defined in #### Defined in
[medusa/src/services/region.ts:240](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L240) [medusa/src/services/region.ts:240](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L240)
___ ___
@@ -750,10 +750,6 @@ ___
Validates a tax rate. Will throw if the tax rate is not between 0 and 1. Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
**`Throws`**
if the tax rate isn't number between 0-100
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -766,9 +762,13 @@ if the tax rate isn't number between 0-100
void void
**`Throws`**
if the tax rate isn't number between 0-100
#### Defined in #### Defined in
[medusa/src/services/region.ts:326](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/region.ts#L326) [medusa/src/services/region.ts:326](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/region.ts#L326)
___ ___
@@ -792,4 +792,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ReturnReasonService.md
+18 -18
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ReturnReasonService**(`__namedParameters`) • **new ReturnReasonService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return-reason.ts#L18) [medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return-reason.ts#L18)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -90,7 +90,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return-reason.ts#L16) [medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return-reason.ts#L16)
___ ___
@@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -161,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -181,7 +181,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return-reason.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return-reason.ts#L25) [medusa/src/services/return-reason.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return-reason.ts#L25)
___ ___
@@ -201,7 +201,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return-reason.ts:113](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return-reason.ts#L113) [medusa/src/services/return-reason.ts:113](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return-reason.ts#L113)
___ ___
@@ -224,7 +224,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/return-reason.ts:68](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return-reason.ts#L68) [medusa/src/services/return-reason.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return-reason.ts#L68)
___ ___
@@ -249,7 +249,7 @@ the order document
#### Defined in #### Defined in
[medusa/src/services/return-reason.ts:87](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return-reason.ts#L87) [medusa/src/services/return-reason.ts:87](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return-reason.ts#L87)
___ ___
@@ -273,7 +273,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -294,7 +294,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return-reason.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return-reason.ts#L46) [medusa/src/services/return-reason.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return-reason.ts#L46)
___ ___
@@ -318,4 +318,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ReturnService.md
+53 -43
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new ReturnService**(`__namedParameters`) • **new ReturnService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/return.ts:64](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L64) [medusa/src/services/return.ts:68](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L68)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,17 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### featureFlagRouter\_
• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[medusa/src/services/return.ts:66](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L66)
___ ___
@@ -76,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L58) [medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L61)
___ ___
@@ -86,7 +96,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L55) [medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L58)
___ ___
@@ -100,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L60) [medusa/src/services/return.ts:63](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L63)
___ ___
@@ -120,7 +130,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L62) [medusa/src/services/return.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L65)
___ ___
@@ -130,7 +140,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L54) [medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L57)
___ ___
@@ -140,7 +150,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L59) [medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L62)
___ ___
@@ -150,7 +160,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L53) [medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L56)
___ ___
@@ -160,7 +170,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L57) [medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L60)
___ ___
@@ -170,7 +180,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L56) [medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L59)
___ ___
@@ -180,7 +190,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L52) [medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L55)
___ ___
@@ -194,7 +204,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -212,7 +222,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -251,7 +261,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -275,7 +285,7 @@ the updated Return
#### Defined in #### Defined in
[medusa/src/services/return.ts:178](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L178) [medusa/src/services/return.ts:184](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L184)
___ ___
@@ -291,7 +301,7 @@ the return lines and the shipping cost.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `data` | `CreateReturnInput` | data to use for the return e.g. shipping_method, items or refund_amount | | `data` | `CreateReturnInput` | data to use for the return e.g. shipping_method, items or refund_amount |
#### Returns #### Returns
@@ -301,7 +311,7 @@ the created return
#### Defined in #### Defined in
[medusa/src/services/return.ts:363](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L363) [medusa/src/services/return.ts:369](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L369)
___ ___
@@ -321,7 +331,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:507](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L507) [medusa/src/services/return.ts:535](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L535)
___ ___
@@ -337,7 +347,7 @@ Retrieves the order line items, given an array of items
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `order` | `Order` | the order to get line items from | | `order` | `Order` | the order to get line items from |
| `items` | `OrdersReturnItem`[] | the items to get | | `items` | `OrdersReturnItem`[] | the items to get |
| `transformer` | `Transformer` | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. | | `transformer` | `Transformer` | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. |
#### Returns #### Returns
@@ -347,7 +357,7 @@ the line items generated by the transformer.
#### Defined in #### Defined in
[medusa/src/services/return.ts:101](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L101) [medusa/src/services/return.ts:107](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L107)
___ ___
@@ -370,7 +380,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/return.ts:141](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L141) [medusa/src/services/return.ts:147](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L147)
___ ___
@@ -393,7 +403,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/return.ts:158](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L158) [medusa/src/services/return.ts:164](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L164)
___ ___
@@ -404,8 +414,8 @@ ___
Registers a previously requested return as received. This will create a Registers a previously requested return as received. This will create a
refund to the customer. If the returned items don't match the requested refund to the customer. If the returned items don't match the requested
items the return status will be updated to requires_action. This behaviour items the return status will be updated to requires_action. This behaviour
is useful in sitautions where a custom refund amount is requested, but the is useful in situations where a custom refund amount is requested, but the
retuned items are not matching the requested items. Setting the returned items are not matching the requested items. Setting the
allowMismatch argument to true, will process the return, ignoring any allowMismatch argument to true, will process the return, ignoring any
mismatches. mismatches.
@@ -428,7 +438,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/return.ts:580](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L580) [medusa/src/services/return.ts:608](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L608)
___ ___
@@ -453,7 +463,7 @@ the return
#### Defined in #### Defined in
[medusa/src/services/return.ts:276](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L276) [medusa/src/services/return.ts:282](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L282)
___ ___
@@ -474,7 +484,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:304](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L304) [medusa/src/services/return.ts:310](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L310)
___ ___
@@ -498,7 +508,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -519,7 +529,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/return.ts:329](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L329) [medusa/src/services/return.ts:335](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L335)
___ ___
@@ -535,7 +545,7 @@ the quantity that is requested to be returned.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ | | :------ | :------ | :------ | :------ |
| `item?` | `LineItem` | `undefined` | the line item to check has sufficient returnable quantity. | | `item?` | `LineItem` | `undefined` | the line item to check has sufficient returnable quantity. |
| `quantity` | `number` | `0` | the quantity that is requested to be returned. | | `quantity` | `number` | `0` | the quantity that is requested to be returned. |
| `additional` | `Object` | `{}` | the quantity that is requested to be returned. | | `additional` | `Object` | `{}` | the quantity that is requested to be returned. |
| `additional.note?` | `string` | `undefined` | - | | `additional.note?` | `string` | `undefined` | - |
@@ -550,7 +560,7 @@ a line item where the quantity is set to the requested
#### Defined in #### Defined in
[medusa/src/services/return.ts:234](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L234) [medusa/src/services/return.ts:240](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L240)
___ ___
@@ -562,10 +572,6 @@ Checks that an order has the statuses necessary to complete a return.
fulfillment_status cannot be not_fulfilled or returned. fulfillment_status cannot be not_fulfilled or returned.
payment_status must be captured. payment_status must be captured.
**`Throws`**
when statuses are not sufficient for returns.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
@@ -576,9 +582,13 @@ when statuses are not sufficient for returns.
`void` `void`
**`Throws`**
when statuses are not sufficient for returns.
#### Defined in #### Defined in
[medusa/src/services/return.ts:204](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/return.ts#L204) [medusa/src/services/return.ts:210](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/return.ts#L210)
___ ___
@@ -602,4 +612,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/SalesChannelInventoryService.md
+16 -16
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new SalesChannelInventoryService**(`__namedParameters`) • **new SalesChannelInventoryService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-inventory.ts#L18) [medusa/src/services/sales-channel-inventory.ts:18](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-inventory.ts#L18)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-inventory.ts#L15) [medusa/src/services/sales-channel-inventory.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-inventory.ts#L15)
___ ___
@@ -86,7 +86,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel-inventory.ts:16](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-inventory.ts#L16) [medusa/src/services/sales-channel-inventory.ts:16](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-inventory.ts#L16)
___ ___
@@ -100,7 +100,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel-inventory.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-inventory.ts#L14) [medusa/src/services/sales-channel-inventory.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-inventory.ts#L14)
___ ___
@@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -142,7 +142,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -181,7 +181,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -206,7 +206,7 @@ available quantity of item across all sales channel locations
#### Defined in #### Defined in
[medusa/src/services/sales-channel-inventory.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-inventory.ts#L37) [medusa/src/services/sales-channel-inventory.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-inventory.ts#L37)
___ ___
@@ -230,7 +230,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -254,4 +254,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/SalesChannelLocationService.md
+19 -19
View File
@@ -12,13 +12,13 @@ Service for managing the stock locations of sales channels
### constructor ### constructor
• **new SalesChannelLocationService**(`__namedParameters`) • **new SalesChannelLocationService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L24) [medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L24)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:21](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L21) [medusa/src/services/sales-channel-location.ts:21](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L21)
___ ___
@@ -92,7 +92,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -102,7 +102,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L20) [medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L20)
___ ___
@@ -112,7 +112,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L22) [medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L22)
___ ___
@@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -144,7 +144,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -169,7 +169,7 @@ A promise that resolves when the association has been created.
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:72](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L72) [medusa/src/services/sales-channel-location.ts:72](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L72)
___ ___
@@ -208,7 +208,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -232,7 +232,7 @@ A promise that resolves with an array of location IDs.
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:103](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L103) [medusa/src/services/sales-channel-location.ts:103](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L103)
___ ___
@@ -256,7 +256,7 @@ A promise that resolves with an array of sales channel IDs.
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:132](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L132) [medusa/src/services/sales-channel-location.ts:132](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L132)
___ ___
@@ -281,7 +281,7 @@ A promise that resolves when the association has been removed.
#### Defined in #### Defined in
[medusa/src/services/sales-channel-location.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel-location.ts#L43) [medusa/src/services/sales-channel-location.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel-location.ts#L43)
___ ___
@@ -305,7 +305,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -329,4 +329,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/SalesChannelService.md
+51 -29
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new SalesChannelService**(`__namedParameters`) • **new SalesChannelService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L34) [medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L34)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L31) [medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L31)
___ ___
@@ -90,17 +90,17 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### salesChannelRepository\_ ### 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`\> } • `Protected` `Readonly` **salesChannelRepository\_**: `Repository`<`SalesChannel`\> & { `addProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `ExtendedFindConfig`<`SalesChannel`\>) => `Promise`<[`SalesChannel`[], `number`]\> ; `listProductIdsBySalesChannelIds`: (`salesChannelIds`: `string` \| `string`[]) => `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> }
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L30) [medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L30)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L32) [medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L32)
___ ___
@@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -142,7 +142,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L24) [medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L24)
## Accessors ## Accessors
@@ -160,7 +160,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -185,7 +185,7 @@ the sales channel on which the products have been added
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:332](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L332) [medusa/src/services/sales-channel.ts:348](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L348)
___ ___
@@ -224,7 +224,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -251,7 +251,7 @@ the created channel
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L168) [medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L168)
___ ___
@@ -269,7 +269,7 @@ the sales channel
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L258) [medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L258)
___ ___
@@ -293,7 +293,7 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L219) [medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L219)
___ ___
@@ -321,7 +321,29 @@ an array containing the sales channels as
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L134) [medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L134)
___
### listProductIdsBySalesChannelIds
▸ **listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\>
List all product ids that belongs to the sales channels ids
#### Parameters
| Name | Type |
| :------ | :------ |
| `salesChannelIds` | `string` \| `string`[] |
#### Returns
`Promise`<{ `[salesChannelId: string]`: `string`[]; }\>
#### Defined in
[medusa/src/services/sales-channel.ts:310](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L310)
___ ___
@@ -346,7 +368,7 @@ the sales channel on which the products have been removed
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:311](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L311) [medusa/src/services/sales-channel.ts:327](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L327)
___ ___
@@ -361,7 +383,7 @@ Retrieve a SalesChannel by id
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `salesChannelId` | `string` | id of the channel to retrieve | | `salesChannelId` | `string` | id of the channel to retrieve |
| `config` | `FindConfig`<`SalesChannel`\> | SC config This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project. | | `config` | `FindConfig`<`SalesChannel`\> | SC config This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project. |
#### Returns #### Returns
@@ -371,7 +393,7 @@ a sales channel
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L92) [medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L92)
___ ___
@@ -396,7 +418,7 @@ a sales channel with matching name
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L113) [medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L113)
___ ___
@@ -414,7 +436,7 @@ the sales channel
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L288) [medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L288)
___ ___
@@ -439,7 +461,7 @@ a single SC matching the query or throws
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L54) [medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L54)
___ ___
@@ -463,7 +485,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -484,7 +506,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L185) [medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L185)
___ ___
@@ -508,4 +530,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/SearchService.md
+14 -14
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new SearchService**(`__namedParameters`, `options`) • **new SearchService**(`«destructured»`, `options`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
| `options` | `any` | | `options` | `any` |
#### Overrides #### Overrides
@@ -25,7 +25,7 @@ AbstractSearchService.constructor
#### Defined in #### Defined in
[medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L16) [medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L16)
## Properties ## Properties
@@ -39,7 +39,7 @@ AbstractSearchService.isDefault
#### Defined in #### Defined in
[medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L11) [medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L11)
___ ___
@@ -49,7 +49,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L13) [medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L13)
___ ___
@@ -63,7 +63,7 @@ AbstractSearchService.options\_
#### Defined in #### Defined in
[medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L14) [medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L14)
## Accessors ## Accessors
@@ -107,7 +107,7 @@ AbstractSearchService.addDocuments
#### Defined in #### Defined in
[medusa/src/services/search.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L40) [medusa/src/services/search.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L40)
___ ___
@@ -132,7 +132,7 @@ AbstractSearchService.createIndex
#### Defined in #### Defined in
[medusa/src/services/search.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L28) [medusa/src/services/search.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L28)
___ ___
@@ -156,7 +156,7 @@ AbstractSearchService.deleteAllDocuments
#### Defined in #### Defined in
[medusa/src/services/search.ts:69](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L69) [medusa/src/services/search.ts:69](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L69)
___ ___
@@ -181,7 +181,7 @@ AbstractSearchService.deleteDocument
#### Defined in #### Defined in
[medusa/src/services/search.ts:60](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L60) [medusa/src/services/search.ts:60](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L60)
___ ___
@@ -205,7 +205,7 @@ AbstractSearchService.getIndex
#### Defined in #### Defined in
[medusa/src/services/search.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L34) [medusa/src/services/search.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L34)
___ ___
@@ -231,7 +231,7 @@ AbstractSearchService.replaceDocuments
#### Defined in #### Defined in
[medusa/src/services/search.ts:50](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L50) [medusa/src/services/search.ts:50](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L50)
___ ___
@@ -257,7 +257,7 @@ AbstractSearchService.search
#### Defined in #### Defined in
[medusa/src/services/search.ts:75](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L75) [medusa/src/services/search.ts:75](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L75)
___ ___
@@ -282,4 +282,4 @@ AbstractSearchService.updateSettings
#### Defined in #### Defined in
[medusa/src/services/search.ts:86](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/search.ts#L86) [medusa/src/services/search.ts:86](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/search.ts#L86)
www/apps/docs/content/references/services/classes/ShippingOptionService.md
+39 -39
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate profiles.
### constructor ### constructor
• **new ShippingOptionService**(`__namedParameters`) • **new ShippingOptionService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L52) [medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L52)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L50) [medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L50)
___ ___
@@ -92,7 +92,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -102,7 +102,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L49) [medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L49)
___ ___
@@ -112,7 +112,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L48) [medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L48)
___ ___
@@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L44) [medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L44)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L45) [medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L45)
___ ___
@@ -142,7 +142,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L47) [medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L47)
___ ___
@@ -156,7 +156,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -174,7 +174,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -200,7 +200,7 @@ the result of update
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:693](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L693) [medusa/src/services/shipping-option.ts:693](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L693)
___ ___
@@ -239,7 +239,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -265,7 +265,7 @@ the result of the create operation
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:431](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L431) [medusa/src/services/shipping-option.ts:431](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L431)
___ ___
@@ -291,7 +291,7 @@ the resulting shipping method.
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L258) [medusa/src/services/shipping-option.ts:258](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L258)
___ ___
@@ -305,7 +305,7 @@ Deletes a profile with a given profile id.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `optionId` | `string` | the id of the profile to delete. Must be castable as an ObjectId | | `optionId` | `string` | the id of the profile to delete. Must be castable as an ObjectId |
#### Returns #### Returns
@@ -315,7 +315,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:671](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L671) [medusa/src/services/shipping-option.ts:671](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L671)
___ ___
@@ -339,7 +339,7 @@ removed shipping methods
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:238](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L238) [medusa/src/services/shipping-option.ts:238](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L238)
___ ___
@@ -355,9 +355,9 @@ price type "calculated".
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `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` \| `Order` \| `Cart` | the context in which the price should be retrieved. | | `cart` | `undefined` \| `Order` \| `Cart` | the context in which the price should be retrieved. |
#### Returns #### Returns
@@ -367,7 +367,7 @@ the price of the shipping option.
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:771](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L771) [medusa/src/services/shipping-option.ts:771](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L771)
___ ___
@@ -390,7 +390,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:145](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L145) [medusa/src/services/shipping-option.ts:145](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L145)
___ ___
@@ -413,7 +413,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:160](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L160) [medusa/src/services/shipping-option.ts:160](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L160)
___ ___
@@ -437,7 +437,7 @@ the result of update
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:722](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L722) [medusa/src/services/shipping-option.ts:722](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L722)
___ ___
@@ -463,7 +463,7 @@ the profile document.
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:177](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L177) [medusa/src/services/shipping-option.ts:177](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L177)
___ ___
@@ -487,7 +487,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -503,7 +503,7 @@ will throw errors if metadata or product updates are attempted.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `optionId` | `string` | the id of the option. Must be a string that can be casted to an ObjectId | | `optionId` | `string` | the id of the option. Must be a string that can be casted to an ObjectId |
| `update` | `UpdateShippingOptionInput` | an object with the update values. | | `update` | `UpdateShippingOptionInput` | an object with the update values. |
#### Returns #### Returns
@@ -514,7 +514,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:559](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L559) [medusa/src/services/shipping-option.ts:559](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L559)
___ ___
@@ -540,7 +540,7 @@ the resulting shipping method
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:211](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L211) [medusa/src/services/shipping-option.ts:211](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L211)
___ ___
@@ -563,7 +563,7 @@ updated shipping options
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:747](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L747) [medusa/src/services/shipping-option.ts:747](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L747)
___ ___
@@ -584,7 +584,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:388](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L388) [medusa/src/services/shipping-option.ts:388](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L388)
___ ___
@@ -611,7 +611,7 @@ the validated shipping option
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:346](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L346) [medusa/src/services/shipping-option.ts:346](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L346)
___ ___
@@ -636,7 +636,7 @@ the validated price
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:519](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L519) [medusa/src/services/shipping-option.ts:519](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L519)
___ ___
@@ -661,7 +661,7 @@ a validated shipping requirement
#### Defined in #### Defined in
[medusa/src/services/shipping-option.ts:77](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-option.ts#L77) [medusa/src/services/shipping-option.ts:77](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-option.ts#L77)
___ ___
@@ -685,4 +685,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/ShippingProfileService.md
+76 -47
View File
@@ -14,13 +14,13 @@ Provides layer to manipulate profiles.
### constructor ### constructor
• **new ShippingProfileService**(`__namedParameters`) • **new ShippingProfileService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L45) [medusa/src/services/shipping-profile.ts:49](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L49)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L40) [medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L43)
___
### featureFlagRouter\_
• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[medusa/src/services/shipping-profile.ts:47](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L47)
___ ___
@@ -94,17 +104,17 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
### productRepository\_ ### productRepository\_
• `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> } • `Protected` `Readonly` **productRepository\_**: `Repository`<`Product`\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<`Product`\>, `__namedParameters`: `Object`) => `SelectQueryBuilder`<`Product`\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions` ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[`Product`[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<`Product`[]\> ; `findOneWithRelations`: (`relations`: `string`[], `optionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<`Product`\> ; `findWithRelations`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `string`[] \| `FindWithoutRelationsOptions`, `withDeleted`: `boolean`) => `Promise`<`Product`[]\> ; `findWithRelationsAndCount`: (`relations`: `string`[], `idsOrOptionsWithoutRelations`: `FindWithoutRelationsOptions`) => `Promise`<[`Product`[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: `CategoryQueryParams`, `includeCategoryChildren`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: `ProductCategory`) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `FindWithoutRelationsOptions`, `relations`: `string`[]) => `Promise`<[`Product`[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: `FindWithoutRelationsOptions`, `shouldCount`: `boolean`) => `Promise`<[`Product`[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof `Product`[] ; `where?`: `FindOptionsWhere`<`Product`\> ; `withDeleted?`: `boolean` }) => `Promise`<`Product`[]\> }
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L43) [medusa/src/services/shipping-profile.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L46)
___ ___
@@ -114,7 +124,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L38) [medusa/src/services/shipping-profile.ts:41](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L41)
___ ___
@@ -124,17 +134,17 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L39) [medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L42)
___ ___
### shippingProfileRepository\_ ### shippingProfileRepository\_
• `Protected` `Readonly` **shippingProfileRepository\_**: `Repository`<`ShippingProfile`\> • `Protected` `Readonly` **shippingProfileRepository\_**: `Repository`<`ShippingProfile`\> & { `findByProducts`: (`productIds`: `string` \| `string`[]) => `Promise`<{ `[product_id: string]`: `ShippingProfile`[]; }\> }
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L42) [medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L45)
___ ___
@@ -148,7 +158,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -166,7 +176,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -174,10 +184,6 @@ TransactionBaseService.activeManager\_
▸ **addProduct**(`profileId`, `productId`): `Promise`<`ShippingProfile`\> ▸ **addProduct**(`profileId`, `productId`): `Promise`<`ShippingProfile`\>
**`Deprecated`**
use [addProducts](ShippingProfileService.md#addproducts) instead
#### Parameters #### Parameters
| Name | Type | | Name | Type |
@@ -189,9 +195,13 @@ use [addProducts](ShippingProfileService.md#addproducts) instead
`Promise`<`ShippingProfile`\> `Promise`<`ShippingProfile`\>
**`Deprecated`**
use [addProducts](ShippingProfileService.md#addproducts) instead
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:345](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L345) [medusa/src/services/shipping-profile.ts:371](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L371)
___ ___
@@ -216,7 +226,7 @@ the result of update
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:358](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L358) [medusa/src/services/shipping-profile.ts:384](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L384)
___ ___
@@ -242,7 +252,7 @@ the result of the model update operation
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:401](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L401) [medusa/src/services/shipping-profile.ts:427](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L427)
___ ___
@@ -281,7 +291,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -305,7 +315,7 @@ the result of the create operation
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:249](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L249) [medusa/src/services/shipping-profile.ts:275](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L275)
___ ___
@@ -323,7 +333,7 @@ the shipping profile
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:179](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L179) [medusa/src/services/shipping-profile.ts:205](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L205)
___ ___
@@ -342,7 +352,7 @@ the shipping profile
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:223](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L223) [medusa/src/services/shipping-profile.ts:249](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L249)
___ ___
@@ -356,7 +366,7 @@ Deletes a profile with a given profile id.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `profileId` | `string` | the id of the profile to delete. Must be castable as an ObjectId | | `profileId` | `string` | the id of the profile to delete. Must be castable as an ObjectId |
#### Returns #### Returns
@@ -366,7 +376,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:323](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L323) [medusa/src/services/shipping-profile.ts:349](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L349)
___ ___
@@ -391,34 +401,33 @@ a list of the available shipping options
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:426](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L426) [medusa/src/services/shipping-profile.ts:452](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L452)
___ ___
### fetchOptionsByProductIds ### getMapProfileIdsByProductIds
▸ **fetchOptionsByProductIds**(`productIds`, `filter`): `Promise`<`ShippingOption`[]\> ▸ **getMapProfileIdsByProductIds**(`productIds`): `Promise`<`Map`<`string`, `string`\>\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `productIds` | `string`[] | | `productIds` | `string`[] |
| `filter` | `Selector`<`ShippingOption`\> |
#### Returns #### Returns
`Promise`<`ShippingOption`[]\> `Promise`<`Map`<`string`, `string`\>\>
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:82](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L82) [medusa/src/services/shipping-profile.ts:88](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L88)
___ ___
### getProfilesInCart ### getProfilesInCart
▸ `Protected` **getProfilesInCart**(`cart`): `string`[] ▸ `Protected` **getProfilesInCart**(`cart`): `Promise`<`string`[]\>
Returns a list of all the productIds in the cart. Returns a list of all the productIds in the cart.
@@ -430,13 +439,13 @@ Returns a list of all the productIds in the cart.
#### Returns #### Returns
`string`[] `Promise`<`string`[]\>
a list of product ids a list of product ids
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:492](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L492) [medusa/src/services/shipping-profile.ts:518](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L518)
___ ___
@@ -459,7 +468,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L67) [medusa/src/services/shipping-profile.ts:73](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L73)
___ ___
@@ -484,7 +493,7 @@ the result of update
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:380](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L380) [medusa/src/services/shipping-profile.ts:406](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L406)
___ ___
@@ -510,7 +519,7 @@ the profile document.
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:134](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L134) [medusa/src/services/shipping-profile.ts:130](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L130)
___ ___
@@ -524,7 +533,27 @@ ___
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:163](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L163) [medusa/src/services/shipping-profile.ts:189](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L189)
___
### retrieveForProducts
▸ **retrieveForProducts**(`productIds`): `Promise`<{ `[product_id: string]`: `ShippingProfile`[]; }\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `productIds` | `string` \| `string`[] |
#### Returns
`Promise`<{ `[product_id: string]`: `ShippingProfile`[]; }\>
#### Defined in
[medusa/src/services/shipping-profile.ts:159](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L159)
___ ___
@@ -542,7 +571,7 @@ the shipping profile for gift cards
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:206](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L206) [medusa/src/services/shipping-profile.ts:232](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L232)
___ ___
@@ -566,7 +595,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -582,7 +611,7 @@ will throw errors if metadata or product updates are attempted.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `profileId` | `string` | the id of the profile. Must be a string that can be casted to an ObjectId | | `profileId` | `string` | the id of the profile. Must be a string that can be casted to an ObjectId |
| `update` | `UpdateShippingProfile` | an object with the update values. | | `update` | `UpdateShippingProfile` | an object with the update values. |
#### Returns #### Returns
@@ -593,7 +622,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/shipping-profile.ts:284](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/shipping-profile.ts#L284) [medusa/src/services/shipping-profile.ts:310](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/shipping-profile.ts#L310)
___ ___
@@ -617,4 +646,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/StagedJobService.md
+16 -16
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate users.
### constructor ### constructor
• **new StagedJobService**(`__namedParameters`) • **new StagedJobService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `StagedJobServiceProps` | | `«destructured»` | `StagedJobServiceProps` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/staged-job.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/staged-job.ts#L22) [medusa/src/services/staged-job.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/staged-job.ts#L22)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -82,7 +82,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -92,7 +92,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/staged-job.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/staged-job.ts#L20) [medusa/src/services/staged-job.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/staged-job.ts#L20)
___ ___
@@ -106,7 +106,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -124,7 +124,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -163,7 +163,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -183,7 +183,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/staged-job.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/staged-job.ts#L45) [medusa/src/services/staged-job.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/staged-job.ts#L45)
___ ___
@@ -203,7 +203,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/staged-job.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/staged-job.ts#L37) [medusa/src/services/staged-job.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/staged-job.ts#L37)
___ ___
@@ -223,7 +223,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/staged-job.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/staged-job.ts#L29) [medusa/src/services/staged-job.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/staged-job.ts#L29)
___ ___
@@ -247,7 +247,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -271,4 +271,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/StoreService.md
+21 -21
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate store settings.
### constructor ### constructor
• **new StoreService**(`__namedParameters`) • **new StoreService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L28) [medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L28)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L25) [medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L25)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/store.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L26) [medusa/src/services/store.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L26)
___ ___
@@ -102,7 +102,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -112,7 +112,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L24) [medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L24)
___ ___
@@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -144,7 +144,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -168,7 +168,7 @@ result after update
#### Defined in #### Defined in
[medusa/src/services/store.ts:208](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L208) [medusa/src/services/store.ts:208](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L208)
___ ___
@@ -207,7 +207,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -225,7 +225,7 @@ The store.
#### Defined in #### Defined in
[medusa/src/services/store.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L45) [medusa/src/services/store.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L45)
___ ___
@@ -245,7 +245,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/store.ts:100](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L100) [medusa/src/services/store.ts:100](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L100)
___ ___
@@ -269,7 +269,7 @@ result after update
#### Defined in #### Defined in
[medusa/src/services/store.ts:252](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L252) [medusa/src/services/store.ts:252](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L252)
___ ___
@@ -293,7 +293,7 @@ the store
#### Defined in #### Defined in
[medusa/src/services/store.ts:83](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L83) [medusa/src/services/store.ts:83](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L83)
___ ___
@@ -317,7 +317,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -341,7 +341,7 @@ resolves to the update result.
#### Defined in #### Defined in
[medusa/src/services/store.ts:116](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/store.ts#L116) [medusa/src/services/store.ts:116](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/store.ts#L116)
___ ___
@@ -365,4 +365,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/StrategyResolverService.md
+12 -12
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/strategy-resolver.ts#L11) [medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/strategy-resolver.ts#L11)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -76,7 +76,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/strategy-resolver.ts#L11) [medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/strategy-resolver.ts#L11)
___ ___
@@ -90,7 +90,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -104,7 +104,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -161,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -181,7 +181,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/strategy-resolver.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/strategy-resolver.ts#L15) [medusa/src/services/strategy-resolver.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/strategy-resolver.ts#L15)
___ ___
@@ -205,7 +205,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -229,4 +229,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/SwapService.md
+44 -44
View File
@@ -12,13 +12,13 @@ Handles swaps
### constructor ### constructor
• **new SwapService**(`__namedParameters`) • **new SwapService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedProps` | | `«destructured»` | `InjectedProps` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L91) [medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L91)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L77) [medusa/src/services/swap.ts:77](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L77)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L87) [medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L87)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L78) [medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L78)
___ ___
@@ -108,7 +108,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L83) [medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L83)
___ ___
@@ -118,7 +118,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L86) [medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L86)
___ ___
@@ -128,7 +128,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L82) [medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L82)
___ ___
@@ -142,7 +142,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L79) [medusa/src/services/swap.ts:79](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L79)
___ ___
@@ -162,7 +162,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L85) [medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L85)
___ ___
@@ -172,7 +172,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L89) [medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L89)
___ ___
@@ -182,7 +182,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L80) [medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L80)
___ ___
@@ -192,7 +192,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L84) [medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L84)
___ ___
@@ -202,7 +202,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L75) [medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L75)
___ ___
@@ -212,7 +212,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L81) [medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L81)
___ ___
@@ -226,7 +226,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -250,7 +250,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L63) [medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L63)
## Accessors ## Accessors
@@ -268,7 +268,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -288,7 +288,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/services/swap.ts:1240](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L1240) [medusa/src/services/swap.ts:1240](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L1240)
___ ___
@@ -327,7 +327,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -353,7 +353,7 @@ the canceled swap.
#### Defined in #### Defined in
[medusa/src/services/swap.ts:857](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L857) [medusa/src/services/swap.ts:857](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L857)
___ ___
@@ -377,7 +377,7 @@ updated swap
#### Defined in #### Defined in
[medusa/src/services/swap.ts:1059](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L1059) [medusa/src/services/swap.ts:1059](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L1059)
___ ___
@@ -398,7 +398,7 @@ and an optional return shipping method.
| `returnShipping?` | `Object` | an optional shipping method for returning the returnItems | | `returnShipping?` | `Object` | an optional shipping method for returning the returnItems |
| `returnShipping.option_id` | `string` | - | | `returnShipping.option_id` | `string` | - |
| `returnShipping.price?` | `number` | - | | `returnShipping.price?` | `number` | - |
| `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.location_id?` | `string` | - |
@@ -412,7 +412,7 @@ the newly created swap
#### Defined in #### Defined in
[medusa/src/services/swap.ts:321](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L321) [medusa/src/services/swap.ts:321](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L321)
___ ___
@@ -442,7 +442,7 @@ the swap with its cart_id prop set to the id of the new cart.
#### Defined in #### Defined in
[medusa/src/services/swap.ts:577](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L577) [medusa/src/services/swap.ts:577](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L577)
___ ___
@@ -468,7 +468,7 @@ the updated swap with new status and fulfillments.
#### Defined in #### Defined in
[medusa/src/services/swap.ts:919](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L919) [medusa/src/services/swap.ts:919](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L919)
___ ___
@@ -495,7 +495,7 @@ the updated swap with new fulfillments and status.
#### Defined in #### Defined in
[medusa/src/services/swap.ts:1090](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L1090) [medusa/src/services/swap.ts:1090](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L1090)
___ ___
@@ -520,7 +520,7 @@ resolves to the updated result.
#### Defined in #### Defined in
[medusa/src/services/swap.ts:1168](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L1168) [medusa/src/services/swap.ts:1168](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L1168)
___ ___
@@ -545,7 +545,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/swap.ts:273](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L273) [medusa/src/services/swap.ts:273](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L273)
___ ___
@@ -570,7 +570,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/swap.ts:293](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L293) [medusa/src/services/swap.ts:293](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L293)
___ ___
@@ -594,7 +594,7 @@ processed swap
#### Defined in #### Defined in
[medusa/src/services/swap.ts:421](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L421) [medusa/src/services/swap.ts:421](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L421)
___ ___
@@ -618,7 +618,7 @@ swap related to the cart
#### Defined in #### Defined in
[medusa/src/services/swap.ts:724](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L724) [medusa/src/services/swap.ts:724](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L724)
___ ___
@@ -643,7 +643,7 @@ the resulting order
#### Defined in #### Defined in
[medusa/src/services/swap.ts:1206](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L1206) [medusa/src/services/swap.ts:1206](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L1206)
___ ___
@@ -668,7 +668,7 @@ the swap
#### Defined in #### Defined in
[medusa/src/services/swap.ts:203](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L203) [medusa/src/services/swap.ts:203](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L203)
___ ___
@@ -693,7 +693,7 @@ the swap
#### Defined in #### Defined in
[medusa/src/services/swap.ts:246](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L246) [medusa/src/services/swap.ts:246](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L246)
___ ___
@@ -717,7 +717,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -741,7 +741,7 @@ transformed find swap config
#### Defined in #### Defined in
[medusa/src/services/swap.ts:130](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L130) [medusa/src/services/swap.ts:130](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L130)
___ ___
@@ -766,7 +766,7 @@ updated swap record
#### Defined in #### Defined in
[medusa/src/services/swap.ts:544](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/swap.ts#L544) [medusa/src/services/swap.ts:544](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/swap.ts#L544)
___ ___
@@ -790,4 +790,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/SystemPaymentProviderService.md
+21 -21
View File
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L6) [medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L6)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -94,7 +94,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:4](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L4) [medusa/src/services/system-payment-provider.ts:4](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L4)
## Accessors ## Accessors
@@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -161,7 +161,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -181,7 +181,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L22) [medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L22)
___ ___
@@ -201,7 +201,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L46) [medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L46)
___ ___
@@ -221,7 +221,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L38) [medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L38)
___ ___
@@ -241,7 +241,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L10) [medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L10)
___ ___
@@ -261,7 +261,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L34) [medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L34)
___ ___
@@ -281,7 +281,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L18) [medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L18)
___ ___
@@ -301,7 +301,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L14) [medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L14)
___ ___
@@ -321,7 +321,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L42) [medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L42)
___ ___
@@ -345,7 +345,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -365,7 +365,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L30) [medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L30)
___ ___
@@ -385,7 +385,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/system-payment-provider.ts#L26) [medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/system-payment-provider.ts#L26)
___ ___
@@ -409,4 +409,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/TaxProviderService.md
+37 -37
View File
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L45) [medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L45)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:38](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L38) [medusa/src/services/tax-provider.ts:38](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L38)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L37) [medusa/src/services/tax-provider.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L37)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L43) [medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L43)
___ ___
@@ -112,7 +112,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -122,7 +122,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L41) [medusa/src/services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L41)
___ ___
@@ -132,7 +132,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L40) [medusa/src/services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L40)
___ ___
@@ -142,7 +142,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L42) [medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L42)
___ ___
@@ -152,7 +152,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:39](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L39) [medusa/src/services/tax-provider.ts:39](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L39)
___ ___
@@ -166,7 +166,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -184,7 +184,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -223,7 +223,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -243,7 +243,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:89](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L89) [medusa/src/services/tax-provider.ts:89](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L89)
___ ___
@@ -263,13 +263,13 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L97) [medusa/src/services/tax-provider.ts:97](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L97)
___ ___
### createShippingTaxLines ### createShippingTaxLines
▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<(`ShippingMethodTaxLine` \| `LineItemTaxLine`)[]\> ▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
Persists the tax lines relevant for a shipping method to the database. Used Persists the tax lines relevant for a shipping method to the database. Used
for return shipping methods. for return shipping methods.
@@ -283,19 +283,19 @@ for return shipping methods.
#### Returns #### Returns
`Promise`<(`ShippingMethodTaxLine` \| `LineItemTaxLine`)[]\> `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
the newly created tax lines the newly created tax lines
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:171](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L171) [medusa/src/services/tax-provider.ts:171](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L171)
___ ___
### createTaxLines ### createTaxLines
▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<(`ShippingMethodTaxLine` \| `LineItemTaxLine`)[]\> ▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
Persists the tax lines relevant for an order to the database. Persists the tax lines relevant for an order to the database.
@@ -303,18 +303,18 @@ Persists the tax lines relevant for an order to the database.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cartOrLineItems` | `Cart` \| `LineItem`[] | the cart or line items to create tax lines for | | `cartOrLineItems` | `LineItem`[] \| `Cart` | the cart or line items to create tax lines for |
| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by | | `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |
#### Returns #### Returns
`Promise`<(`ShippingMethodTaxLine` \| `LineItemTaxLine`)[]\> `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
the newly created tax lines the newly created tax lines
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:117](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L117) [medusa/src/services/tax-provider.ts:117](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L117)
___ ___
@@ -339,7 +339,7 @@ the cache key to use for the id set
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:499](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L499) [medusa/src/services/tax-provider.ts:492](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L492)
___ ___
@@ -365,7 +365,7 @@ the tax rates configured for the shipping option. A map by product id
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:434](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L434) [medusa/src/services/tax-provider.ts:427](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L427)
___ ___
@@ -391,7 +391,7 @@ the tax rates configured for the shipping option.
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:387](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L387) [medusa/src/services/tax-provider.ts:380](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L380)
___ ___
@@ -418,13 +418,13 @@ the computed tax lines
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:192](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L192) [medusa/src/services/tax-provider.ts:192](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L192)
___ ___
### getTaxLines ### getTaxLines
▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<(`ShippingMethodTaxLine` \| `LineItemTaxLine`)[]\> ▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
Gets the relevant tax lines for an order or cart. If an order is provided Gets the relevant tax lines for an order or cart. If an order is provided
the order's tax lines will be returned. If a cart is provided the tax lines the order's tax lines will be returned. If a cart is provided the tax lines
@@ -441,13 +441,13 @@ wish to persist the tax lines to the DB layer.
#### Returns #### Returns
`Promise`<(`ShippingMethodTaxLine` \| `LineItemTaxLine`)[]\> `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
the computed tax lines the computed tax lines
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:246](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L246) [medusa/src/services/tax-provider.ts:246](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L246)
___ ___
@@ -470,7 +470,7 @@ Return a map of tax lines for line items and shipping methods
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:350](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L350) [medusa/src/services/tax-provider.ts:343](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L343)
___ ___
@@ -484,7 +484,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:57](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L57) [medusa/src/services/tax-provider.ts:57](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L57)
___ ___
@@ -504,7 +504,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:503](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L503) [medusa/src/services/tax-provider.ts:496](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L496)
___ ___
@@ -528,7 +528,7 @@ the region specific tax provider
#### Defined in #### Defined in
[medusa/src/services/tax-provider.ts:67](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-provider.ts#L67) [medusa/src/services/tax-provider.ts:67](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-provider.ts#L67)
___ ___
@@ -552,7 +552,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -576,4 +576,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/TaxRateService.md
+30 -30
View File
@@ -10,13 +10,13 @@
### constructor ### constructor
• **new TaxRateService**(`__namedParameters`) • **new TaxRateService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `Object` | | `«destructured»` | `Object` |
#### Overrides #### Overrides
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L29) [medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L29)
## Properties ## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -90,7 +90,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L24) [medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L24)
___ ___
@@ -100,7 +100,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L25) [medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L25)
___ ___
@@ -110,7 +110,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L26) [medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L26)
___ ___
@@ -120,7 +120,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L27) [medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L27)
___ ___
@@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -152,7 +152,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -174,7 +174,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L190) [medusa/src/services/tax-rate.ts:190](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L190)
___ ___
@@ -196,7 +196,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L226) [medusa/src/services/tax-rate.ts:226](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L226)
___ ___
@@ -218,7 +218,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L266) [medusa/src/services/tax-rate.ts:266](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L266)
___ ___
@@ -257,7 +257,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -277,7 +277,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:93](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L93) [medusa/src/services/tax-rate.ts:93](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L93)
___ ___
@@ -297,7 +297,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:124](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L124) [medusa/src/services/tax-rate.ts:124](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L124)
___ ___
@@ -318,7 +318,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:44](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L44) [medusa/src/services/tax-rate.ts:44](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L44)
___ ___
@@ -339,7 +339,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:55](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L55) [medusa/src/services/tax-rate.ts:55](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L55)
___ ___
@@ -360,7 +360,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L314) [medusa/src/services/tax-rate.ts:314](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L314)
___ ___
@@ -380,7 +380,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:325](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L325) [medusa/src/services/tax-rate.ts:325](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L325)
___ ___
@@ -401,7 +401,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L136) [medusa/src/services/tax-rate.ts:136](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L136)
___ ___
@@ -422,7 +422,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L154) [medusa/src/services/tax-rate.ts:154](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L154)
___ ___
@@ -443,7 +443,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L172) [medusa/src/services/tax-rate.ts:172](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L172)
___ ___
@@ -464,7 +464,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L66) [medusa/src/services/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L66)
___ ___
@@ -488,7 +488,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -509,7 +509,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/tax-rate.ts:109](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/tax-rate.ts#L109) [medusa/src/services/tax-rate.ts:109](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/tax-rate.ts#L109)
___ ___
@@ -533,4 +533,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/TokenService.md
+7 -7
View File
@@ -4,17 +4,17 @@
### constructor ### constructor
• **new TokenService**(`__namedParameters`) • **new TokenService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `InjectedDependencies` | | `«destructured»` | `InjectedDependencies` |
#### Defined in #### Defined in
[medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/token.ts#L16) [medusa/src/services/token.ts:16](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/token.ts#L16)
## Properties ## Properties
@@ -24,7 +24,7 @@
#### Defined in #### Defined in
[medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/token.ts#L14) [medusa/src/services/token.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/token.ts#L14)
___ ___
@@ -34,7 +34,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/token.ts#L12) [medusa/src/services/token.ts:12](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/token.ts#L12)
## Methods ## Methods
@@ -55,7 +55,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/token.ts#L34) [medusa/src/services/token.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/token.ts#L34)
___ ___
@@ -76,4 +76,4 @@ ___
#### Defined in #### Defined in
[medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/token.ts#L20) [medusa/src/services/token.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/token.ts#L20)
www/apps/docs/content/references/services/classes/TotalsService.md
+44 -40
View File
@@ -14,13 +14,13 @@ A service that calculates total and subtotals for orders, carts etc..
### constructor ### constructor
• **new TotalsService**(`__namedParameters`) • **new TotalsService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `TotalsServiceProps` | | `«destructured»` | `TotalsServiceProps` |
#### Overrides #### Overrides
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L112) [medusa/src/services/totals.ts:112](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L112)
## Properties ## Properties
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -70,7 +70,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -80,7 +80,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L110) [medusa/src/services/totals.ts:110](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L110)
___ ___
@@ -94,7 +94,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -104,7 +104,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L108) [medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L108)
___ ___
@@ -114,7 +114,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L109) [medusa/src/services/totals.ts:109](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L109)
___ ___
@@ -124,7 +124,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/totals.ts:107](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L107) [medusa/src/services/totals.ts:107](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L107)
___ ___
@@ -138,7 +138,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
## Accessors ## Accessors
@@ -156,7 +156,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -195,7 +195,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -221,9 +221,13 @@ Calculates either fixed or percentage discount of a variant
triples of lineitem, variant and applied discount triples of lineitem, variant and applied discount
**`Deprecated`**
- in favour of DiscountService.calculateDiscountForLineItem
#### Defined in #### Defined in
[medusa/src/services/totals.ts:626](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L626) [medusa/src/services/totals.ts:627](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L627)
___ ___
@@ -252,7 +256,7 @@ array of triples of lineitem, variant and applied discount
#### Defined in #### Defined in
[medusa/src/services/totals.ts:668](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L668) [medusa/src/services/totals.ts:669](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L669)
___ ___
@@ -283,7 +287,7 @@ the allocation map for the line items in the cart or order.
#### Defined in #### Defined in
[medusa/src/services/totals.ts:435](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L435) [medusa/src/services/totals.ts:435](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L435)
___ ___
@@ -308,7 +312,7 @@ the tax calculation context
#### Defined in #### Defined in
[medusa/src/services/totals.ts:1027](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L1027) [medusa/src/services/totals.ts:1028](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L1028)
___ ___
@@ -333,7 +337,7 @@ the total discounts amount
#### Defined in #### Defined in
[medusa/src/services/totals.ts:1005](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L1005) [medusa/src/services/totals.ts:1006](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L1006)
___ ___
@@ -359,7 +363,7 @@ the gift card amount applied to the cart or order
#### Defined in #### Defined in
[medusa/src/services/totals.ts:974](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L974) [medusa/src/services/totals.ts:975](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L975)
___ ___
@@ -384,7 +388,7 @@ the gift card amount applied to the cart or order
#### Defined in #### Defined in
[medusa/src/services/totals.ts:957](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L957) [medusa/src/services/totals.ts:958](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L958)
___ ___
@@ -413,7 +417,7 @@ the allocations that the discount has on the items in the cart or
#### Defined in #### Defined in
[medusa/src/services/totals.ts:719](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L719) [medusa/src/services/totals.ts:720](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L720)
___ ___
@@ -433,7 +437,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/totals.ts:696](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L696) [medusa/src/services/totals.ts:697](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L697)
___ ___
@@ -454,7 +458,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/totals.ts:681](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L681) [medusa/src/services/totals.ts:682](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L682)
___ ___
@@ -479,7 +483,7 @@ the line item refund amount.
#### Defined in #### Defined in
[medusa/src/services/totals.ts:504](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L504) [medusa/src/services/totals.ts:504](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L504)
___ ___
@@ -506,7 +510,7 @@ the line item total
#### Defined in #### Defined in
[medusa/src/services/totals.ts:930](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L930) [medusa/src/services/totals.ts:931](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L931)
___ ___
@@ -534,7 +538,7 @@ the breakdown of the line item totals
#### Defined in #### Defined in
[medusa/src/services/totals.ts:775](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L775) [medusa/src/services/totals.ts:776](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L776)
___ ___
@@ -558,7 +562,7 @@ the total paid amount
#### Defined in #### Defined in
[medusa/src/services/totals.ts:157](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L157) [medusa/src/services/totals.ts:157](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L157)
___ ___
@@ -585,7 +589,7 @@ the calculated subtotal
#### Defined in #### Defined in
[medusa/src/services/totals.ts:583](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L583) [medusa/src/services/totals.ts:583](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L583)
___ ___
@@ -609,7 +613,7 @@ the total refunded amount for an order.
#### Defined in #### Defined in
[medusa/src/services/totals.ts:489](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L489) [medusa/src/services/totals.ts:489](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L489)
___ ___
@@ -636,7 +640,7 @@ An object that breaks down the totals for the shipping method
#### Defined in #### Defined in
[medusa/src/services/totals.ts:191](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L191) [medusa/src/services/totals.ts:191](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L191)
___ ___
@@ -660,7 +664,7 @@ shipping total
#### Defined in #### Defined in
[medusa/src/services/totals.ts:319](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L319) [medusa/src/services/totals.ts:319](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L319)
___ ___
@@ -685,7 +689,7 @@ the calculated subtotal
#### Defined in #### Defined in
[medusa/src/services/totals.ts:283](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L283) [medusa/src/services/totals.ts:283](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L283)
___ ___
@@ -710,7 +714,7 @@ the swap total
#### Defined in #### Defined in
[medusa/src/services/totals.ts:172](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L172) [medusa/src/services/totals.ts:172](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L172)
___ ___
@@ -726,7 +730,7 @@ Currently based on the Danish tax system
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ | | :------ | :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | `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
@@ -736,7 +740,7 @@ tax total
#### Defined in #### Defined in
[medusa/src/services/totals.ts:346](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L346) [medusa/src/services/totals.ts:346](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L346)
___ ___
@@ -761,7 +765,7 @@ the calculated subtotal
#### Defined in #### Defined in
[medusa/src/services/totals.ts:134](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L134) [medusa/src/services/totals.ts:134](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L134)
___ ___
@@ -785,7 +789,7 @@ the rounded value
#### Defined in #### Defined in
[medusa/src/services/totals.ts:1057](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/totals.ts#L1057) [medusa/src/services/totals.ts:1058](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/totals.ts#L1058)
___ ___
@@ -809,7 +813,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -833,4 +837,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
www/apps/docs/content/references/services/classes/UserService.md
+28 -28
View File
@@ -12,13 +12,13 @@ Provides layer to manipulate users.
### constructor ### constructor
• **new UserService**(`__namedParameters`) • **new UserService**(`«destructured»`)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `__namedParameters` | `UserServiceProps` | | `«destructured»` | `UserServiceProps` |
#### Overrides #### Overrides
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
#### Defined in #### Defined in
[medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L45) [medusa/src/services/user.ts:45](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L45)
## Properties ## Properties
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14) [medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___ ___
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13) [medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___ ___
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15) [medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___ ___
@@ -78,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L40) [medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L40)
___ ___
@@ -88,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L42) [medusa/src/services/user.ts:42](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L42)
___ ___
@@ -98,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L43) [medusa/src/services/user.ts:43](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L43)
___ ___
@@ -112,7 +112,7 @@ TransactionBaseService.manager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5) [medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___ ___
@@ -126,7 +126,7 @@ TransactionBaseService.transactionManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6) [medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___ ___
@@ -136,7 +136,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L41) [medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L41)
___ ___
@@ -155,7 +155,7 @@ ___
#### Defined in #### Defined in
[medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L33) [medusa/src/services/user.ts:33](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L33)
## Accessors ## Accessors
@@ -173,7 +173,7 @@ TransactionBaseService.activeManager\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8) [medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods ## Methods
@@ -212,7 +212,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56) [medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___ ___
@@ -238,7 +238,7 @@ the result of create
#### Defined in #### Defined in
[medusa/src/services/user.ts:171](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L171) [medusa/src/services/user.ts:171](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L171)
___ ___
@@ -252,7 +252,7 @@ Deletes a user from a given user id.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `userId` | `string` | the id of the user to delete. Must be castable as an ObjectId | | `userId` | `string` | the id of the user to delete. Must be castable as an ObjectId |
#### Returns #### Returns
@@ -262,7 +262,7 @@ the result of the delete operation.
#### Defined in #### Defined in
[medusa/src/services/user.ts:263](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L263) [medusa/src/services/user.ts:263](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L263)
___ ___
@@ -290,7 +290,7 @@ the generated JSON web token
#### Defined in #### Defined in
[medusa/src/services/user.ts:327](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L327) [medusa/src/services/user.ts:327](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L327)
___ ___
@@ -314,7 +314,7 @@ hashed password
#### Defined in #### Defined in
[medusa/src/services/user.ts:159](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L159) [medusa/src/services/user.ts:159](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L159)
___ ___
@@ -337,7 +337,7 @@ the result of the find operation
#### Defined in #### Defined in
[medusa/src/services/user.ts:65](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L65) [medusa/src/services/user.ts:65](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L65)
___ ___
@@ -363,7 +363,7 @@ the user document.
#### Defined in #### Defined in
[medusa/src/services/user.ts:77](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L77) [medusa/src/services/user.ts:77](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L77)
___ ___
@@ -389,7 +389,7 @@ the user document.
#### Defined in #### Defined in
[medusa/src/services/user.ts:107](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L107) [medusa/src/services/user.ts:107](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L107)
___ ___
@@ -415,7 +415,7 @@ the user document.
#### Defined in #### Defined in
[medusa/src/services/user.ts:135](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L135) [medusa/src/services/user.ts:135](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L135)
___ ___
@@ -442,7 +442,7 @@ the result of the update operation
#### Defined in #### Defined in
[medusa/src/services/user.ts:298](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L298) [medusa/src/services/user.ts:298](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L298)
___ ___
@@ -466,7 +466,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37) [medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___ ___
@@ -491,7 +491,7 @@ the result of create
#### Defined in #### Defined in
[medusa/src/services/user.ts:217](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/user.ts#L217) [medusa/src/services/user.ts:217](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/user.ts#L217)
___ ___
@@ -515,4 +515,4 @@ TransactionBaseService.withTransaction
#### Defined in #### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20) [medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)