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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
docs/content/references/services/classes/AuthService.md
View File

@@ -1,5 +1,7 @@
# Class: AuthService
Can authenticate a user based on email password combination
## Hierarchy
- `TransactionBaseService`<[`AuthService`](AuthService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;AuthService\&gt;.constructor
#### Defined in
[services/auth.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L25)
[packages/medusa/src/services/auth.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L25)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;AuthService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### customerService\_
@@ -54,7 +64,7 @@ ___
#### Defined in
[services/auth.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L23)
[packages/medusa/src/services/auth.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L23)
___
@@ -68,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/auth.ts:20](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L20)
[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L20)
___
@@ -82,7 +92,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/auth.ts:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L21)
[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L21)
___
@@ -92,7 +102,7 @@ ___
#### Defined in
[services/auth.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L22)
[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L22)
## Methods
@@ -100,6 +110,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -111,21 +125,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -133,20 +149,27 @@ ___
▸ **authenticate**(`email`, `password`): `Promise`<`AuthenticateResult`\>
Authenticates a given user based on an email, password combination. Uses
scrypt to match password with hashed value.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `email` | `string` | |
| `password` | `string` | |
| `email` | `string` | the email of the user |
| `password` | `string` | the password of the user |
#### Returns
`Promise`<`AuthenticateResult`\>
success: whether authentication succeeded
user: the user document if authentication succeded
error: a string with the error message
#### Defined in
[services/auth.ts:98](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L98)
[packages/medusa/src/services/auth.ts:98](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L98)
___
@@ -154,19 +177,25 @@ ___
▸ **authenticateAPIToken**(`token`): `Promise`<`AuthenticateResult`\>
Authenticates a given user with an API token
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `token` | `string` | |
| `token` | `string` | the api_token of the user to authenticate |
#### Returns
`Promise`<`AuthenticateResult`\>
success: whether authentication succeeded
user: the user document if authentication succeded
error: a string with the error message
#### Defined in
[services/auth.ts:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L55)
[packages/medusa/src/services/auth.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L55)
___
@@ -174,20 +203,27 @@ ___
▸ **authenticateCustomer**(`email`, `password`): `Promise`<`AuthenticateResult`\>
Authenticates a customer based on an email, password combination. Uses
scrypt to match password with hashed value.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `email` | `string` | |
| `password` | `string` | |
| `email` | `string` | the email of the user |
| `password` | `string` | the password of the user |
#### Returns
`Promise`<`AuthenticateResult`\>
success: whether authentication succeeded
user: the user document if authentication succeded
error: a string with the error message
#### Defined in
[services/auth.ts:147](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L147)
[packages/medusa/src/services/auth.ts:147](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L147)
___
@@ -195,20 +231,24 @@ ___
▸ `Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\>
Verifies if a password is valid given the provided password hash
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `password` | `string` | |
| `hash` | `string` | |
| `password` | `string` | the raw password to check |
| `hash` | `string` | the hash to compare against |
#### Returns
`Promise`<`boolean`\>
the result of the comparison
#### Defined in
[services/auth.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L39)
[packages/medusa/src/services/auth.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L39)
___
@@ -232,7 +272,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -256,4 +296,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

66
docs/content/references/services/classes/BatchJobService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService&lt;BatchJobService\&gt;.constructor
#### Defined in
[services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L93)
[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L93)
## Properties
@@ -34,7 +34,7 @@ TransactionBaseService&lt;BatchJobService\&gt;.constructor
#### Defined in
[services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L41)
[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L41)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
[services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L45)
[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L45)
___
@@ -56,6 +56,10 @@ ___
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -66,6 +70,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
@@ -74,7 +82,7 @@ ___
#### Defined in
[services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L42)
[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L42)
___
@@ -88,7 +96,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L38)
[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L38)
___
@@ -98,7 +106,7 @@ ___
#### Defined in
[services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L43)
[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L43)
___
@@ -112,7 +120,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L39)
[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L39)
___
@@ -135,7 +143,7 @@ ___
#### Defined in
[services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L27)
[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L27)
## Methods
@@ -143,6 +151,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -154,21 +166,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -188,7 +202,7 @@ ___
#### Defined in
[services/batch-job.ts:284](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L284)
[packages/medusa/src/services/batch-job.ts:274](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L274)
___
@@ -208,7 +222,7 @@ ___
#### Defined in
[services/batch-job.ts:266](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L266)
[packages/medusa/src/services/batch-job.ts:256](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L256)
___
@@ -228,7 +242,7 @@ ___
#### Defined in
[services/batch-job.ts:248](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L248)
[packages/medusa/src/services/batch-job.ts:238](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L238)
___
@@ -248,7 +262,7 @@ ___
#### Defined in
[services/batch-job.ts:153](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L153)
[packages/medusa/src/services/batch-job.ts:143](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L143)
___
@@ -269,7 +283,7 @@ ___
#### Defined in
[services/batch-job.ts:137](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L137)
[packages/medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L132)
___
@@ -290,7 +304,7 @@ ___
#### Defined in
[services/batch-job.ts:380](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L380)
[packages/medusa/src/services/batch-job.ts:370](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L370)
___
@@ -311,7 +325,7 @@ ___
#### Defined in
[services/batch-job.ts:112](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L112)
[packages/medusa/src/services/batch-job.ts:112](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L112)
___
@@ -332,7 +346,7 @@ ___
#### Defined in
[services/batch-job.ts:354](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L354)
[packages/medusa/src/services/batch-job.ts:344](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L344)
___
@@ -352,7 +366,7 @@ ___
#### Defined in
[services/batch-job.ts:302](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L302)
[packages/medusa/src/services/batch-job.ts:292](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L292)
___
@@ -372,7 +386,7 @@ ___
#### Defined in
[services/batch-job.ts:334](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L334)
[packages/medusa/src/services/batch-job.ts:324](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L324)
___
@@ -396,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -417,7 +431,7 @@ ___
#### Defined in
[services/batch-job.ts:172](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L172)
[packages/medusa/src/services/batch-job.ts:162](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L162)
___
@@ -438,7 +452,7 @@ ___
#### Defined in
[services/batch-job.ts:213](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L213)
[packages/medusa/src/services/batch-job.ts:203](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L203)
___
@@ -462,4 +476,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

485
docs/content/references/services/classes/CartService.md
View File

File diff suppressed because it is too large Load Diff

66
docs/content/references/services/classes/ClaimItemService.md
View File

@@ -24,7 +24,7 @@ BaseService&lt;ClaimItemService\&gt;.constructor
#### Defined in
[services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L30)
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L30)
## Properties
@@ -34,7 +34,7 @@ BaseService&lt;ClaimItemService\&gt;.constructor
#### Defined in
[services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L25)
[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L25)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
[services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L23)
[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L23)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
[services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L24)
[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L24)
___
@@ -66,6 +66,10 @@ ___
BaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -76,6 +80,10 @@ ___
BaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
@@ -84,7 +92,7 @@ ___
#### Defined in
[services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L22)
[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L22)
___
@@ -94,7 +102,7 @@ ___
#### Defined in
[services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L21)
[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L21)
___
@@ -108,7 +116,7 @@ BaseService.manager\_
#### Defined in
[services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L27)
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L27)
___
@@ -122,7 +130,7 @@ BaseService.transactionManager\_
#### Defined in
[services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L28)
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L28)
___
@@ -140,7 +148,7 @@ ___
#### Defined in
[services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L15)
[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L15)
## Methods
@@ -148,6 +156,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -159,21 +171,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
BaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -193,7 +207,7 @@ ___
#### Defined in
[services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L49)
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L49)
___
@@ -205,16 +219,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`ClaimItem`\> | |
| `config` | `FindConfig`<`ClaimItem`\> | |
| `selector` | `Selector`<`ClaimItem`\> | the query object for find |
| `config` | `FindConfig`<`ClaimItem`\> | the config object for find |
#### Returns
`Promise`<`ClaimItem`[]\>
the result of the find operation
#### Defined in
[services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L214)
[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L214)
___
@@ -222,20 +238,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimItem`\>
Gets a claim item by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`ClaimItem`\> | |
| `id` | `string` | id of ClaimItem to retrieve |
| `config` | `FindConfig`<`ClaimItem`\> | configuration for the find operation |
#### Returns
`Promise`<`ClaimItem`\>
the ClaimItem
#### Defined in
[services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L233)
[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L233)
___
@@ -259,7 +279,7 @@ BaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -280,7 +300,7 @@ ___
#### Defined in
[services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L132)
[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L132)
___
@@ -304,4 +324,4 @@ BaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

116
docs/content/references/services/classes/ClaimService.md
View File

@@ -27,7 +27,7 @@ TransactionBaseService&lt;
#### Defined in
[services/claim.ts:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L85)
[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L85)
## Properties
@@ -37,7 +37,7 @@ TransactionBaseService&lt;
#### Defined in
[services/claim.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L68)
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L68)
___
@@ -47,7 +47,7 @@ ___
#### Defined in
[services/claim.ts:72](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L72)
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L72)
___
@@ -57,7 +57,7 @@ ___
#### Defined in
[services/claim.ts:69](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L69)
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L69)
___
@@ -69,6 +69,10 @@ ___
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -79,6 +83,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
@@ -87,7 +95,7 @@ ___
#### Defined in
[services/claim.ts:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L73)
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L73)
___
@@ -97,7 +105,7 @@ ___
#### Defined in
[services/claim.ts:74](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L74)
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L74)
___
@@ -107,7 +115,7 @@ ___
#### Defined in
[services/claim.ts:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L75)
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L75)
___
@@ -117,7 +125,7 @@ ___
#### Defined in
[services/claim.ts:76](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L76)
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L76)
___
@@ -127,7 +135,7 @@ ___
#### Defined in
[services/claim.ts:71](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L71)
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L71)
___
@@ -137,7 +145,7 @@ ___
#### Defined in
[services/claim.ts:77](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L77)
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L77)
___
@@ -151,7 +159,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/claim.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L65)
[packages/medusa/src/services/claim.ts:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L65)
___
@@ -161,7 +169,7 @@ ___
#### Defined in
[services/claim.ts:78](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L78)
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L78)
___
@@ -171,7 +179,7 @@ ___
#### Defined in
[services/claim.ts:79](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L79)
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L79)
___
@@ -181,7 +189,7 @@ ___
#### Defined in
[services/claim.ts:80](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L80)
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L80)
___
@@ -191,7 +199,7 @@ ___
#### Defined in
[services/claim.ts:70](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L70)
[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L70)
___
@@ -201,7 +209,7 @@ ___
#### Defined in
[services/claim.ts:81](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L81)
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L81)
___
@@ -211,7 +219,7 @@ ___
#### Defined in
[services/claim.ts:82](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L82)
[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L82)
___
@@ -221,7 +229,7 @@ ___
#### Defined in
[services/claim.ts:83](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L83)
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L83)
___
@@ -235,7 +243,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/claim.ts:66](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L66)
[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L66)
___
@@ -256,7 +264,7 @@ ___
#### Defined in
[services/claim.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L56)
[packages/medusa/src/services/claim.ts:56](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L56)
## Methods
@@ -264,6 +272,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -275,21 +287,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -309,7 +323,7 @@ ___
#### Defined in
[services/claim.ts:753](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L753)
[packages/medusa/src/services/claim.ts:753](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L753)
___
@@ -329,7 +343,7 @@ ___
#### Defined in
[services/claim.ts:602](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L602)
[packages/medusa/src/services/claim.ts:602](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L602)
___
@@ -337,19 +351,25 @@ ___
▸ **create**(`data`): `Promise`<`ClaimOrder`\>
Creates a Claim on an Order. Claims consists of items that are claimed and
optionally items to be sent as replacement for the claimed items. The
shipping address that the new items will be shipped to
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateClaimInput` | |
| `data` | `CreateClaimInput` | the object containing all data required to create a claim |
#### Returns
`Promise`<`ClaimOrder`\>
created claim
#### Defined in
[services/claim.ts:217](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L217)
[packages/medusa/src/services/claim.ts:217](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L217)
___
@@ -361,18 +381,20 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `Object` | |
| `config.metadata?` | `Record`<`string`, `unknown`\> | |
| `config.no_notification?` | `boolean` | |
| `id` | `string` | the object containing all data required to create a claim |
| `config` | `Object` | config object |
| `config.metadata?` | `Record`<`string`, `unknown`\> | config metadata |
| `config.no_notification?` | `boolean` | config no notification |
#### Returns
`Promise`<`ClaimOrder`\>
created claim
#### Defined in
[services/claim.ts:456](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L456)
[packages/medusa/src/services/claim.ts:456](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L456)
___
@@ -397,7 +419,7 @@ ___
#### Defined in
[services/claim.ts:674](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L674)
[packages/medusa/src/services/claim.ts:674](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L674)
___
@@ -409,16 +431,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `FindConfig`<`ClaimOrder`\> | |
| `selector` | `any` | the query object for find |
| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings |
#### Returns
`Promise`<`ClaimOrder`[]\>
the result of the find operation
#### Defined in
[services/claim.ts:809](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L809)
[packages/medusa/src/services/claim.ts:809](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L809)
___
@@ -438,7 +462,7 @@ ___
#### Defined in
[services/claim.ts:628](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L628)
[packages/medusa/src/services/claim.ts:628](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L628)
___
@@ -446,20 +470,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimOrder`\>
Gets an order by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`ClaimOrder`\> | |
| `id` | `string` | id of the claim order to retrieve |
| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings |
#### Returns
`Promise`<`ClaimOrder`\>
the order document
#### Defined in
[services/claim.ts:834](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L834)
[packages/medusa/src/services/claim.ts:829](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L829)
___
@@ -483,7 +511,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -504,7 +532,7 @@ ___
#### Defined in
[services/claim.ts:127](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L127)
[packages/medusa/src/services/claim.ts:127](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L127)
___
@@ -528,4 +556,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

62
docs/content/references/services/classes/CustomShippingOptionService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService&lt;CustomShippingOptionService\&gt;.constructor
#### Defined in
[services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L19)
[packages/medusa/src/services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L19)
## Properties
@@ -36,6 +36,10 @@ TransactionBaseService&lt;CustomShippingOptionService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +50,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### customShippingOptionRepository\_
@@ -54,7 +62,7 @@ ___
#### Defined in
[services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L17)
[packages/medusa/src/services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L17)
___
@@ -68,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L15)
[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L15)
___
@@ -82,7 +90,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L16)
[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L16)
## Methods
@@ -90,6 +98,10 @@ TransactionBaseService.transactionManager\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -101,21 +113,23 @@ TransactionBaseService.transactionManager\_
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -123,19 +137,23 @@ ___
▸ **create**(`data`): `Promise`<`CustomShippingOption`\>
Creates a custom shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateCustomShippingOptionInput` | |
| `data` | `CreateCustomShippingOptionInput` | the custom shipping option to create |
#### Returns
`Promise`<`CustomShippingOption`\>
resolves to the creation result
#### Defined in
[services/custom-shipping-option.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L90)
[packages/medusa/src/services/custom-shipping-option.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L88)
___
@@ -143,20 +161,24 @@ ___
▸ **list**(`selector`, `config?`): `Promise`<`CustomShippingOption`[]\>
Fetches all custom shipping options based on the given selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`CustomShippingOption`\> | |
| `config` | `FindConfig`<`CustomShippingOption`\> | |
| `selector` | `Selector`<`CustomShippingOption`\> | the query object for find |
| `config` | `FindConfig`<`CustomShippingOption`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<`CustomShippingOption`[]\>
custom shipping options matching the query
#### Defined in
[services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L65)
[packages/medusa/src/services/custom-shipping-option.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L64)
___
@@ -164,20 +186,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`CustomShippingOption`\>
Retrieves a specific shipping option.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`CustomShippingOption`\> | |
| `id` | `string` | the id of the custom shipping option to retrieve. |
| `config` | `FindConfig`<`CustomShippingOption`\> | any options needed to query for the result. |
#### Returns
`Promise`<`CustomShippingOption`\>
the requested custom shipping option.
#### Defined in
[services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L36)
[packages/medusa/src/services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L36)
___
@@ -201,7 +227,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -225,4 +251,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

82
docs/content/references/services/classes/CustomerGroupService.md
View File

@@ -1,5 +1,9 @@
# Class: CustomerGroupService
Provides layer to manipulate discounts.
**`Implements`**
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +28,7 @@ BaseService.constructor
#### Defined in
[services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L31)
[packages/medusa/src/services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L31)
## Properties
@@ -34,7 +38,7 @@ BaseService.constructor
#### Defined in
[services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L27)
[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L27)
___
@@ -44,7 +48,7 @@ ___
#### Defined in
[services/customer-group.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L29)
[packages/medusa/src/services/customer-group.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L29)
___
@@ -54,7 +58,7 @@ ___
#### Defined in
[services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L25)
[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L25)
## Methods
@@ -62,20 +66,24 @@ ___
▸ **addCustomers**(`id`, `customerIds`): `Promise`<`CustomerGroup`\>
Add a batch of customers to a customer group at once
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `customerIds` | `string` \| `string`[] | |
| `id` | `string` | id of the customer group to add customers to |
| `customerIds` | `string` \| `string`[] | customer id's to add to the group |
#### Returns
`Promise`<`CustomerGroup`\>
the customer group after insertion
#### Defined in
[services/customer-group.ts:113](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L113)
[packages/medusa/src/services/customer-group.ts:113](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L113)
___
@@ -83,11 +91,13 @@ ___
▸ **create**(`group`): `Promise`<`CustomerGroup`\>
Creates a customer group with the provided data.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `group` | `Object` | |
| `group` | `Object` | the customer group to create |
| `group.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
| `group.customers?` | (`undefined` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef...)[] | - |
| `group.deleted_at?` | ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - |
@@ -101,9 +111,11 @@ ___
`Promise`<`CustomerGroup`\>
the result of the create operation
#### Defined in
[services/customer-group.ts:86](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L86)
[packages/medusa/src/services/customer-group.ts:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L86)
___
@@ -111,19 +123,23 @@ ___
▸ **delete**(`groupId`): `Promise`<`void`\>
Remove customer group
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `groupId` | `string` | |
| `groupId` | `string` | id of the customer group to delete |
#### Returns
`Promise`<`void`\>
a promise
#### Defined in
[services/customer-group.ts:194](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L194)
[packages/medusa/src/services/customer-group.ts:194](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L194)
___
@@ -131,20 +147,24 @@ ___
▸ **list**(`selector?`, `config`): `Promise`<`CustomerGroup`[]\>
List customer groups.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableCustomerGroupProps` | |
| `config` | `FindConfig`<`CustomerGroup`\> | |
| `selector` | `FilterableCustomerGroupProps` | the query object for find |
| `config` | `FindConfig`<`CustomerGroup`\> | the config to be used for find |
#### Returns
`Promise`<`CustomerGroup`[]\>
the result of the find operation
#### Defined in
[services/customer-group.ts:217](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L217)
[packages/medusa/src/services/customer-group.ts:217](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L217)
___
@@ -152,20 +172,24 @@ ___
▸ **listAndCount**(`selector?`, `config`): `Promise`<[`CustomerGroup`[], `number`]\>
Retrieve a list of customer groups and total count of records that match the query.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableCustomerGroupProps` | |
| `config` | `FindConfig`<`CustomerGroup`\> | |
| `selector` | `FilterableCustomerGroupProps` | the query object for find |
| `config` | `FindConfig`<`CustomerGroup`\> | the config to be used for find |
#### Returns
`Promise`<[`CustomerGroup`[], `number`]\>
the result of the find operation
#### Defined in
[services/customer-group.ts:236](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L236)
[packages/medusa/src/services/customer-group.ts:236](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L236)
___
@@ -173,20 +197,24 @@ ___
▸ **removeCustomer**(`id`, `customerIds`): `Promise`<`CustomerGroup`\>
Remove list of customers from a customergroup
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `customerIds` | `string` \| `string`[] | |
| `id` | `string` | id of the customer group from which the customers are removed |
| `customerIds` | `string` \| `string`[] | id's of the customer to remove from group |
#### Returns
`Promise`<`CustomerGroup`\>
the customergroup with the provided id
#### Defined in
[services/customer-group.ts:271](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L271)
[packages/medusa/src/services/customer-group.ts:271](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L271)
___
@@ -207,7 +235,7 @@ ___
#### Defined in
[services/customer-group.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L62)
[packages/medusa/src/services/customer-group.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L62)
___
@@ -215,20 +243,24 @@ ___
▸ **update**(`customerGroupId`, `update`): `Promise`<`CustomerGroup`[]\>
Update a customer group.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `customerGroupId` | `string` | |
| `update` | `CustomerGroupUpdate` | |
| `customerGroupId` | `string` | id of the customer group |
| `update` | `CustomerGroupUpdate` | customer group partial data |
#### Returns
`Promise`<`CustomerGroup`[]\>
resulting customer group
#### Defined in
[services/customer-group.ts:162](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L162)
[packages/medusa/src/services/customer-group.ts:162](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L162)
___
@@ -248,4 +280,4 @@ ___
#### Defined in
[services/customer-group.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L46)
[packages/medusa/src/services/customer-group.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L46)

161
docs/content/references/services/classes/CustomerService.md
View File

@@ -1,5 +1,7 @@
# Class: CustomerService
Provides layer to manipulate customers.
## Hierarchy
- `TransactionBaseService`<[`CustomerService`](CustomerService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;CustomerService\&gt;.constructor
#### Defined in
[services/customer.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L40)
[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L39)
## Properties
@@ -34,7 +36,7 @@ TransactionBaseService&lt;CustomerService\&gt;.constructor
#### Defined in
[services/customer.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L28)
[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L27)
___
@@ -46,6 +48,10 @@ ___
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -56,6 +62,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### customerRepository\_
@@ -64,7 +74,7 @@ ___
#### Defined in
[services/customer.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L27)
[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L26)
___
@@ -74,7 +84,7 @@ ___
#### Defined in
[services/customer.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L29)
[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L28)
___
@@ -88,7 +98,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/customer.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L31)
[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L30)
___
@@ -102,7 +112,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/customer.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L32)
[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L31)
___
@@ -120,7 +130,7 @@ ___
#### Defined in
[services/customer.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L34)
[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L33)
## Methods
@@ -141,7 +151,7 @@ ___
#### Defined in
[services/customer.ts:471](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L471)
[packages/medusa/src/services/customer.ts:461](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L461)
___
@@ -149,6 +159,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -160,21 +174,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -182,13 +198,17 @@ ___
▸ **count**(): `Promise`<`number`\>
Return the total number of documents in database
#### Returns
`Promise`<`number`\>
the result of the count operation
#### Defined in
[services/customer.ts:161](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L161)
[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L158)
___
@@ -196,19 +216,26 @@ ___
▸ **create**(`customer`): `Promise`<`Customer`\>
Creates a customer from an email - customers can have accounts associated,
e.g. to login and view order history, etc. If a password is provided the
customer will automatically get an account, otherwise the customer is just
used to hold details of customers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `customer` | `CreateCustomerInput` | |
| `customer` | `CreateCustomerInput` | the customer to create |
#### Returns
`Promise`<`Customer`\>
the result of create
#### Defined in
[services/customer.ts:255](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L255)
[packages/medusa/src/services/customer.ts:245](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L245)
___
@@ -216,19 +243,23 @@ ___
▸ **delete**(`customerId`): `Promise`<`void` \| `Customer`\>
Deletes a customer from a given customer id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `customerId` | `string` | |
| `customerId` | `string` | the id of the customer to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`void` \| `Customer`\>
the result of the delete operation.
#### Defined in
[services/customer.ts:519](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L519)
[packages/medusa/src/services/customer.ts:509](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L509)
___
@@ -236,19 +267,27 @@ ___
▸ **generateResetPasswordToken**(`customerId`): `Promise`<`string`\>
Generate a JSON Web token, that will be sent to a customer, that wishes to
reset password.
The token will be signed with the customer's current password hash as a
secret a long side a payload with userId and the expiry time for the token,
which is always 15 minutes.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `customerId` | `string` | |
| `customerId` | `string` | the customer to reset the password for |
#### Returns
`Promise`<`string`\>
the generated JSON web token
#### Defined in
[services/customer.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L65)
[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L64)
___
@@ -256,19 +295,23 @@ ___
▸ **hashPassword_**(`password`): `Promise`<`string`\>
Hashes a password
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `password` | `string` | |
| `password` | `string` | the value to hash |
#### Returns
`Promise`<`string`\>
hashed password
#### Defined in
[services/customer.ts:242](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L242)
[packages/medusa/src/services/customer.ts:232](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L232)
___
@@ -280,16 +323,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | |
| `config` | `FindConfig`<`Customer`\> | |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
`Promise`<`Customer`[]\>
the result of the find operation
#### Defined in
[services/customer.ts:108](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L108)
[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L107)
___
@@ -301,16 +346,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | |
| `config` | `FindConfig`<`Customer`\> | |
| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
`Promise`<[`Customer`[], `number`]\>
the result of the find operation
#### Defined in
[services/customer.ts:133](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L133)
[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L131)
___
@@ -331,7 +378,7 @@ ___
#### Defined in
[services/customer.ts:454](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L454)
[packages/medusa/src/services/customer.ts:444](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L444)
___
@@ -339,20 +386,24 @@ ___
▸ **retrieve**(`customerId`, `config?`): `Promise`<`Customer`\>
Gets a customer by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `customerId` | `string` | |
| `config` | `FindConfig`<`Customer`\> | |
| `customerId` | `string` | the id of the customer to get. |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
`Promise`<`Customer`\>
the customer document.
#### Defined in
[services/customer.ts:228](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L228)
[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L220)
___
@@ -360,20 +411,24 @@ ___
▸ **retrieveByEmail**(`email`, `config?`): `Promise`<`Customer`\>
Gets a customer by email.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `email` | `string` | |
| `config` | `FindConfig`<`Customer`\> | |
| `email` | `string` | the email of the customer to get. |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
`Promise`<`Customer`\>
the customer document.
#### Defined in
[services/customer.ts:198](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L198)
[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L194)
___
@@ -381,20 +436,24 @@ ___
▸ **retrieveByPhone**(`phone`, `config?`): `Promise`<`Customer`\>
Gets a customer by phone.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `phone` | `string` | |
| `config` | `FindConfig`<`Customer`\> | |
| `phone` | `string` | the phone of the customer to get. |
| `config` | `FindConfig`<`Customer`\> | the config object containing query settings |
#### Returns
`Promise`<`Customer`\>
the customer document.
#### Defined in
[services/customer.ts:213](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L213)
[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L207)
___
@@ -415,7 +474,7 @@ ___
#### Defined in
[services/customer.ts:168](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L168)
[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L164)
___
@@ -439,7 +498,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -447,20 +506,24 @@ ___
▸ **update**(`customerId`, `update`): `Promise`<`Customer`\>
Updates a customer.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `customerId` | `string` | |
| `update` | `UpdateCustomerInput` | |
| `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. |
#### Returns
`Promise`<`Customer`\>
resolves to the update result.
#### Defined in
[services/customer.ts:310](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L310)
[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L300)
___
@@ -482,7 +545,7 @@ ___
#### Defined in
[services/customer.ts:426](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L426)
[packages/medusa/src/services/customer.ts:416](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L416)
___
@@ -490,20 +553,24 @@ ___
▸ **updateBillingAddress_**(`customer`, `addressOrId`): `Promise`<`void`\>
Updates the customers' billing address.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `customer` | `Customer` | |
| `addressOrId` | `undefined` \| `string` \| { `address_1?`: ``null`` \| `string` ; `address_2?`: ``null`` \| `string` ; `city?`: ``null`` \| `string` ; `company?`: ``null`` \| `string` ; `country?`: ``null`` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; } ; `country_code?`: ``null`` \| `string` ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `customer?`: ``null`` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef... ; `customer_id?`: ``null`` \| `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `first_name?`: ``null`` \| `string` ; `id?`: `string` ; `last_name?`: ``null`` \| `string` ; `metadata?`: { [x: string]: unknown; } ; `phone?`: ``null`` \| `string` ; `postal_code?`: ``null`` \| `string` ; `province?`: ``null`` \| `string` ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } } | |
| `customer` | `Customer` | the Customer to update |
| `addressOrId` | `undefined` \| `string` \| { `address_1?`: ``null`` \| `string` ; `address_2?`: ``null`` \| `string` ; `city?`: ``null`` \| `string` ; `company?`: ``null`` \| `string` ; `country?`: ``null`` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; } ; `country_code?`: ``null`` \| `string` ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `customer?`: ``null`` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef... ; `customer_id?`: ``null`` \| `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `first_name?`: ``null`` \| `string` ; `id?`: `string` ; `last_name?`: ``null`` \| `string` ; `metadata?`: { [x: string]: unknown; } ; `phone?`: ``null`` \| `string` ; `postal_code?`: ``null`` \| `string` ; `province?`: ``null`` \| `string` ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } } | the value to set the billing address to |
#### Returns
`Promise`<`void`\>
the result of the update operation
#### Defined in
[services/customer.ts:374](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L374)
[packages/medusa/src/services/customer.ts:364](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L364)
___
@@ -527,4 +594,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

185
docs/content/references/services/classes/DiscountService.md
View File

@@ -1,5 +1,9 @@
# Class: DiscountService
Provides layer to manipulate discounts.
**`Implements`**
## Hierarchy
- `TransactionBaseService`<[`DiscountService`](DiscountService.md)\>
@@ -24,7 +28,7 @@ TransactionBaseService&lt;DiscountService\&gt;.constructor
#### Defined in
[services/discount.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L62)
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L62)
## Properties
@@ -36,6 +40,10 @@ TransactionBaseService&lt;DiscountService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +54,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### customerService\_
@@ -54,7 +66,7 @@ ___
#### Defined in
[services/discount.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L52)
[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L52)
___
@@ -64,7 +76,7 @@ ___
#### Defined in
[services/discount.ts:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L55)
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L55)
___
@@ -74,7 +86,7 @@ ___
#### Defined in
[services/discount.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L56)
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L56)
___
@@ -84,7 +96,7 @@ ___
#### Defined in
[services/discount.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L51)
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L51)
___
@@ -94,7 +106,7 @@ ___
#### Defined in
[services/discount.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L53)
[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L53)
___
@@ -104,7 +116,7 @@ ___
#### Defined in
[services/discount.ts:60](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L60)
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L60)
___
@@ -114,7 +126,7 @@ ___
#### Defined in
[services/discount.ts:54](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L54)
[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L54)
___
@@ -128,7 +140,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/discount.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L48)
[packages/medusa/src/services/discount.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L48)
___
@@ -138,7 +150,7 @@ ___
#### Defined in
[services/discount.ts:58](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L58)
[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L58)
___
@@ -148,7 +160,7 @@ ___
#### Defined in
[services/discount.ts:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L59)
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L59)
___
@@ -158,7 +170,7 @@ ___
#### Defined in
[services/discount.ts:57](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L57)
[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L57)
___
@@ -172,7 +184,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/discount.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L49)
[packages/medusa/src/services/discount.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L49)
## Methods
@@ -180,20 +192,24 @@ TransactionBaseService.transactionManager\_
▸ **addRegion**(`discountId`, `regionId`): `Promise`<`Discount`\>
Adds a region to the discount regions array.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | |
| `regionId` | `string` | |
| `discountId` | `string` | id of discount |
| `regionId` | `string` | id of region to add |
#### Returns
`Promise`<`Discount`\>
the result of the update operation
#### Defined in
[services/discount.ts:477](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L477)
[packages/medusa/src/services/discount.ts:465](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L465)
___
@@ -201,6 +217,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -212,21 +232,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -248,7 +270,7 @@ ___
#### Defined in
[services/discount.ts:576](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L576)
[packages/medusa/src/services/discount.ts:566](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L566)
___
@@ -269,7 +291,7 @@ ___
#### Defined in
[services/discount.ts:720](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L720)
[packages/medusa/src/services/discount.ts:710](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L710)
___
@@ -277,19 +299,24 @@ ___
▸ **create**(`discount`): `Promise`<`Discount`\>
Creates a discount with provided data given that the data is validated.
Normalizes discount code to uppercase.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discount` | `CreateDiscountInput` | |
| `discount` | `CreateDiscountInput` | the discount data to create |
#### Returns
`Promise`<`Discount`\>
the result of the create operation
#### Defined in
[services/discount.ts:182](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L182)
[packages/medusa/src/services/discount.ts:176](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L176)
___
@@ -297,20 +324,24 @@ ___
▸ **createDynamicCode**(`discountId`, `data`): `Promise`<`Discount`\>
Creates a dynamic code for a discount id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | |
| `data` | `CreateDynamicDiscountInput` | |
| `discountId` | `string` | the id of the discount to create a code for |
| `data` | `CreateDynamicDiscountInput` | the object containing a code to identify the discount by |
#### Returns
`Promise`<`Discount`\>
the newly created dynamic code
#### Defined in
[services/discount.ts:405](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L405)
[packages/medusa/src/services/discount.ts:393](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L393)
___
@@ -318,19 +349,23 @@ ___
▸ **delete**(`discountId`): `Promise`<`void`\>
Deletes a discount idempotently
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | |
| `discountId` | `string` | id of discount to delete |
#### Returns
`Promise`<`void`\>
the result of the delete operation
#### Defined in
[services/discount.ts:537](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L537)
[packages/medusa/src/services/discount.ts:525](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L525)
___
@@ -338,20 +373,24 @@ ___
▸ **deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\>
Deletes a dynamic code for a discount id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | |
| `code` | `string` | |
| `discountId` | `string` | the id of the discount to create a code for |
| `code` | `string` | the code to identify the discount by |
#### Returns
`Promise`<`void`\>
the newly created dynamic code
#### Defined in
[services/discount.ts:456](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L456)
[packages/medusa/src/services/discount.ts:444](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L444)
___
@@ -371,7 +410,7 @@ ___
#### Defined in
[services/discount.ts:689](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L689)
[packages/medusa/src/services/discount.ts:679](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L679)
___
@@ -391,7 +430,7 @@ ___
#### Defined in
[services/discount.ts:685](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L685)
[packages/medusa/src/services/discount.ts:675](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L675)
___
@@ -411,7 +450,7 @@ ___
#### Defined in
[services/discount.ts:679](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L679)
[packages/medusa/src/services/discount.ts:669](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L669)
___
@@ -431,7 +470,7 @@ ___
#### Defined in
[services/discount.ts:697](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L697)
[packages/medusa/src/services/discount.ts:687](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L687)
___
@@ -452,7 +491,7 @@ ___
#### Defined in
[services/discount.ts:701](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L701)
[packages/medusa/src/services/discount.ts:691](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L691)
___
@@ -464,16 +503,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableDiscountProps` | |
| `config` | `FindConfig`<`Discount`\> | |
| `selector` | `FilterableDiscountProps` | the query object for find |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
#### Returns
`Promise`<`Discount`[]\>
the result of the find operation
#### Defined in
[services/discount.ts:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L114)
[packages/medusa/src/services/discount.ts:114](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L114)
___
@@ -485,16 +526,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableDiscountProps` | |
| `config` | `FindConfig`<`Discount`\> | |
| `selector` | `FilterableDiscountProps` | the query object for find |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
#### Returns
`Promise`<[`Discount`[], `number`]\>
the result of the find operation
#### Defined in
[services/discount.ts:133](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L133)
[packages/medusa/src/services/discount.ts:130](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L130)
___
@@ -502,20 +545,24 @@ ___
▸ **removeRegion**(`discountId`, `regionId`): `Promise`<`Discount`\>
Removes a region from the discount regions array.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | |
| `regionId` | `string` | |
| `discountId` | `string` | id of discount |
| `regionId` | `string` | id of region to remove |
#### Returns
`Promise`<`Discount`\>
the result of the update operation
#### Defined in
[services/discount.ts:512](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L512)
[packages/medusa/src/services/discount.ts:500](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L500)
___
@@ -523,20 +570,24 @@ ___
▸ **retrieve**(`discountId`, `config?`): `Promise`<`Discount`\>
Gets a discount by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | |
| `config` | `FindConfig`<`Discount`\> | |
| `discountId` | `string` | id of discount to retrieve |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
#### Returns
`Promise`<`Discount`\>
the discount
#### Defined in
[services/discount.ts:247](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L247)
[packages/medusa/src/services/discount.ts:241](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L241)
___
@@ -544,20 +595,24 @@ ___
▸ **retrieveByCode**(`discountCode`, `config?`): `Promise`<`Discount`\>
Gets a discount by discount code.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountCode` | `string` | |
| `config` | `FindConfig`<`Discount`\> | |
| `discountCode` | `string` | discount code of discount to retrieve |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
#### Returns
`Promise`<`Discount`\>
the discount document
#### Defined in
[services/discount.ts:276](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L276)
[packages/medusa/src/services/discount.ts:267](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L267)
___
@@ -581,7 +636,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -589,20 +644,24 @@ ___
▸ **update**(`discountId`, `update`): `Promise`<`Discount`\>
Updates a discount.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | |
| `update` | `UpdateDiscountInput` | |
| `discountId` | `string` | discount id of discount to update |
| `update` | `UpdateDiscountInput` | the data to update the discount with |
#### Returns
`Promise`<`Discount`\>
the result of the update operation
#### Defined in
[services/discount.ts:310](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L310)
[packages/medusa/src/services/discount.ts:298](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L298)
___
@@ -623,7 +682,7 @@ ___
#### Defined in
[services/discount.ts:619](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L619)
[packages/medusa/src/services/discount.ts:609](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L609)
___
@@ -644,7 +703,7 @@ ___
#### Defined in
[services/discount.ts:551](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L551)
[packages/medusa/src/services/discount.ts:539](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L539)
___
@@ -652,6 +711,8 @@ ___
▸ **validateDiscountRule_**<`T`\>(`discountRule`): `T`
Creates a discount rule with provided data given that the data is validated.
#### Type parameters
| Name | Type |
@@ -662,15 +723,17 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountRule` | `T` | |
| `discountRule` | `T` | the discount rule to create |
#### Returns
`T`
the result of the create operation
#### Defined in
[services/discount.ts:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L96)
[packages/medusa/src/services/discount.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L96)
___
@@ -694,4 +757,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

130
docs/content/references/services/classes/DraftOrderService.md
View File

@@ -1,5 +1,9 @@
# Class: DraftOrderService
Handles draft orders
**`Implements`**
## Hierarchy
- `TransactionBaseService`<[`DraftOrderService`](DraftOrderService.md)\>
@@ -24,7 +28,7 @@ TransactionBaseService&lt;DraftOrderService\&gt;.constructor
#### Defined in
[services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L51)
[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L51)
## Properties
@@ -34,7 +38,7 @@ TransactionBaseService&lt;DraftOrderService\&gt;.constructor
#### Defined in
[services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L46)
[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L46)
___
@@ -46,6 +50,10 @@ ___
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -56,6 +64,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### draftOrderRepository\_
@@ -64,7 +76,7 @@ ___
#### Defined in
[services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L42)
[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L42)
___
@@ -74,7 +86,7 @@ ___
#### Defined in
[services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L45)
[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L45)
___
@@ -84,7 +96,7 @@ ___
#### Defined in
[services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L47)
[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L47)
___
@@ -98,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L39)
[packages/medusa/src/services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L39)
___
@@ -108,7 +120,7 @@ ___
#### Defined in
[services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L44)
[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L44)
___
@@ -118,7 +130,7 @@ ___
#### Defined in
[services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L43)
[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L43)
___
@@ -128,7 +140,7 @@ ___
#### Defined in
[services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L48)
[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L48)
___
@@ -138,7 +150,7 @@ ___
#### Defined in
[services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L49)
[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L49)
___
@@ -152,7 +164,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L40)
[packages/medusa/src/services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L40)
___
@@ -169,7 +181,7 @@ ___
#### Defined in
[services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L34)
[packages/medusa/src/services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L34)
## Methods
@@ -177,6 +189,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -188,21 +204,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -210,19 +228,23 @@ ___
▸ **create**(`data`): `Promise`<`DraftOrder`\>
Creates a draft order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `AdminPostDraftOrdersReq` | |
| `data` | `AdminPostDraftOrdersReq` | data to create draft order from |
#### Returns
`Promise`<`DraftOrder`\>
the created draft order
#### Defined in
[services/draft-order.ts:257](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L257)
[packages/medusa/src/services/draft-order.ts:245](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L245)
___
@@ -230,19 +252,23 @@ ___
▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| `DraftOrder`\>
Deletes draft order idempotently.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `draftOrderId` | `string` | |
| `draftOrderId` | `string` | id of draft order to delete |
#### Returns
`Promise`<`undefined` \| `DraftOrder`\>
empty promise
#### Defined in
[services/draft-order.ts:150](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L150)
[packages/medusa/src/services/draft-order.ts:144](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L144)
___
@@ -250,20 +276,24 @@ ___
▸ **list**(`selector`, `config?`): `Promise`<`DraftOrder`[]\>
Lists draft orders
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `selector` | `any` | query object for find |
| `config` | `FindConfig`<`DraftOrder`\> | configurable attributes for find |
#### Returns
`Promise`<`DraftOrder`[]\>
list of draft orders
#### Defined in
[services/draft-order.ts:231](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L231)
[packages/medusa/src/services/draft-order.ts:222](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L222)
___
@@ -271,20 +301,24 @@ ___
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`DraftOrder`[], `number`]\>
Lists draft orders alongside the count
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `selector` | `any` | query selector to filter draft orders |
| `config` | `FindConfig`<`DraftOrder`\> | query config |
#### Returns
`Promise`<[`DraftOrder`[], `number`]\>
draft orders
#### Defined in
[services/draft-order.ts:174](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L174)
[packages/medusa/src/services/draft-order.ts:168](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L168)
___
@@ -292,20 +326,24 @@ ___
▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\>
Registers a draft order as completed, when an order has been completed.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `draftOrderId` | `string` | |
| `orderId` | `string` | |
| `draftOrderId` | `string` | id of draft order to complete |
| `orderId` | `string` | id of order completed from draft order cart |
#### Returns
`Promise`<`UpdateResult`\>
the created order
#### Defined in
[services/draft-order.ts:363](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L363)
[packages/medusa/src/services/draft-order.ts:351](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L351)
___
@@ -313,20 +351,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`DraftOrder`\>
Retrieves a draft order with the given id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `id` | `string` | id of the draft order to retrieve |
| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |
#### Returns
`Promise`<`DraftOrder`\>
the draft order
#### Defined in
[services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L91)
[packages/medusa/src/services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L91)
___
@@ -334,20 +376,24 @@ ___
▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<`DraftOrder`\>
Retrieves a draft order based on its associated cart id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartId` | `string` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `cartId` | `string` | cart id that the draft orders's cart has |
| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |
#### Returns
`Promise`<`DraftOrder`\>
the draft order
#### Defined in
[services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L121)
[packages/medusa/src/services/draft-order.ts:118](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L118)
___
@@ -371,7 +417,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -379,21 +425,25 @@ ___
▸ **update**(`id`, `data`): `Promise`<`DraftOrder`\>
Updates a draft order with the given data
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `data` | `Object` | |
| `id` | `string` | id of the draft order |
| `data` | `Object` | values to update the order with |
| `data.no_notification_order` | `boolean` | - |
#### Returns
`Promise`<`DraftOrder`\>
the updated draft order
#### Defined in
[services/draft-order.ts:392](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L392)
[packages/medusa/src/services/draft-order.ts:380](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L380)
___
@@ -417,4 +467,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

111
docs/content/references/services/classes/EventBusService.md
View File

@@ -1,5 +1,8 @@
# Class: EventBusService
Can keep track of multiple subscribers to different events and run the
subscribers when events happen. Events will run asynchronously.
## Constructors
### constructor
@@ -16,7 +19,7 @@
#### Defined in
[services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L38)
[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L38)
## Properties
@@ -26,7 +29,7 @@
#### Defined in
[services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L24)
[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L24)
___
@@ -36,7 +39,7 @@ ___
#### Defined in
[services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L29)
[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L29)
___
@@ -46,7 +49,7 @@ ___
#### Defined in
[services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L32)
[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L32)
___
@@ -56,7 +59,7 @@ ___
#### Defined in
[services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L36)
[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L36)
___
@@ -66,7 +69,7 @@ ___
#### Defined in
[services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L26)
[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L26)
___
@@ -76,7 +79,7 @@ ___
#### Defined in
[services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L25)
[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L25)
___
@@ -86,7 +89,7 @@ ___
#### Defined in
[services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L28)
[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L28)
___
@@ -96,7 +99,7 @@ ___
#### Defined in
[services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L33)
[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L33)
___
@@ -106,7 +109,7 @@ ___
#### Defined in
[services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L30)
[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L30)
___
@@ -116,7 +119,7 @@ ___
#### Defined in
[services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L31)
[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L31)
___
@@ -126,7 +129,7 @@ ___
#### Defined in
[services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L34)
[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L34)
___
@@ -136,7 +139,7 @@ ___
#### Defined in
[services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L27)
[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L27)
___
@@ -146,7 +149,7 @@ ___
#### Defined in
[services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L35)
[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L35)
## Methods
@@ -154,6 +157,8 @@ ___
▸ **createCronJob**<`T`\>(`eventName`, `data`, `cron`, `handler`): `void`
Registers a cron job.
#### Type parameters
| Name |
@@ -164,18 +169,20 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | |
| `data` | `T` | |
| `cron` | `string` | |
| `handler` | `Subscriber`<`unknown`\> | |
| `eventName` | `string` | the name of the event |
| `data` | `T` | the data to be sent with the event |
| `cron` | `string` | the cron pattern |
| `handler` | `Subscriber`<`unknown`\> | the handler to call on each cron job |
#### Returns
`void`
void
#### Defined in
[services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L308)
[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L308)
___
@@ -183,6 +190,8 @@ ___
▸ **cronWorker_**<`T`\>(`job`): `Promise`<`unknown`[]\>
Handles incoming jobs.
#### Type parameters
| Name |
@@ -193,7 +202,7 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `job` | `Object` | |
| `job` | `Object` | The job object |
| `job.data` | `Object` | - |
| `job.data.data` | `T` | - |
| `job.data.eventName` | `string` | - |
@@ -202,9 +211,11 @@ ___
`Promise`<`unknown`[]\>
resolves to the results of the subscriber calls.
#### Defined in
[services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L281)
[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L281)
___
@@ -212,6 +223,8 @@ ___
▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\>
Calls all subscribers when an event occurs.
#### Type parameters
| Name |
@@ -222,18 +235,20 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | |
| `data` | `T` | |
| `options` | `Object` | |
| `eventName` | `string` | the name of the event to be process. |
| `data` | `T` | the data to send to the subscriber. |
| `options` | `Object` | options to add the job with |
| `options.delay?` | `number` | - |
#### Returns
`Promise`<`void` \| `StagedJob`\>
the job from our queue
#### Defined in
[services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L179)
[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L179)
___
@@ -247,7 +262,7 @@ ___
#### Defined in
[services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L215)
[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L215)
___
@@ -255,20 +270,24 @@ ___
▸ `Protected` **registerCronHandler_**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `event` | `string` \| `symbol` | |
| `subscriber` | `Subscriber`<`unknown`\> | |
| `event` | `string` \| `symbol` | the event that the subscriber will listen for. |
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. |
#### Returns
[`EventBusService`](EventBusService.md)
this
#### Defined in
[services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L158)
[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L158)
___
@@ -282,7 +301,7 @@ ___
#### Defined in
[services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L205)
[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L205)
___
@@ -296,7 +315,7 @@ ___
#### Defined in
[services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L210)
[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L210)
___
@@ -304,20 +323,24 @@ ___
▸ **subscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `event` | `string` \| `symbol` | |
| `subscriber` | `Subscriber`<`unknown`\> | |
| `event` | `string` \| `symbol` | the event that the subscriber will listen for. |
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. |
#### Returns
[`EventBusService`](EventBusService.md)
this
#### Defined in
[services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L118)
[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L118)
___
@@ -325,20 +348,24 @@ ___
▸ **unsubscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md)
Adds a function to a list of event subscribers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `event` | `string` \| `symbol` | |
| `subscriber` | `Subscriber`<`unknown`\> | |
| `event` | `string` \| `symbol` | the event that the subscriber will listen for. |
| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. |
#### Returns
[`EventBusService`](EventBusService.md)
this
#### Defined in
[services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L136)
[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L136)
___
@@ -358,7 +385,7 @@ ___
#### Defined in
[services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L88)
[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L88)
___
@@ -366,6 +393,8 @@ ___
▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`[]\>
Handles incoming jobs.
#### Type parameters
| Name |
@@ -376,7 +405,7 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `job` | `Object` | |
| `job` | `Object` | The job object |
| `job.data` | `Object` | - |
| `job.data.data` | `T` | - |
| `job.data.eventName` | `string` | - |
@@ -385,6 +414,8 @@ ___
`Promise`<`unknown`[]\>
resolves to the results of the subscriber calls.
#### Defined in
[services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L250)
[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L250)

40
docs/content/references/services/classes/FulfillmentProviderService.md
View File

@@ -1,5 +1,7 @@
# Class: FulfillmentProviderService
Helps retrive fulfillment providers
## Constructors
### constructor
@@ -14,7 +16,7 @@
#### Defined in
[services/fulfillment-provider.js:7](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L7)
[packages/medusa/src/services/fulfillment-provider.js:7](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L7)
## Methods
@@ -36,7 +38,7 @@
#### Defined in
[services/fulfillment-provider.js:79](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L79)
[packages/medusa/src/services/fulfillment-provider.js:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L79)
___
@@ -56,7 +58,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:64](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L64)
[packages/medusa/src/services/fulfillment-provider.js:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L64)
___
@@ -76,7 +78,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:74](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L74)
[packages/medusa/src/services/fulfillment-provider.js:74](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L74)
___
@@ -99,7 +101,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L59)
[packages/medusa/src/services/fulfillment-provider.js:59](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L59)
___
@@ -119,7 +121,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L89)
[packages/medusa/src/services/fulfillment-provider.js:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L89)
___
@@ -133,7 +135,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L23)
[packages/medusa/src/services/fulfillment-provider.js:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L23)
___
@@ -153,7 +155,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L30)
[packages/medusa/src/services/fulfillment-provider.js:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L30)
___
@@ -173,7 +175,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L12)
[packages/medusa/src/services/fulfillment-provider.js:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L12)
___
@@ -181,13 +183,15 @@ ___
▸ **retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\>
Fetches documents from the fulfillment provider
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `providerId` | `string` | |
| `fulfillmentData` | `any` | |
| `documentType` | ``"label"`` \| ``"invoice"`` | |
| `providerId` | `string` | the id of the provider |
| `fulfillmentData` | `any` | the data relating to the fulfillment |
| `documentType` | ``"label"`` \| ``"invoice"`` | the typ of document to fetch |
#### Returns
@@ -195,7 +199,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L102)
[packages/medusa/src/services/fulfillment-provider.js:102](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L102)
___
@@ -207,15 +211,17 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `provider_id` | `string` | |
| `provider_id` | `string` | the provider id |
#### Returns
`FulfillmentService`
the payment fulfillment provider
#### Defined in
[services/fulfillment-provider.js:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L48)
[packages/medusa/src/services/fulfillment-provider.js:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L48)
___
@@ -237,7 +243,7 @@ ___
#### Defined in
[services/fulfillment-provider.js:69](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L69)
[packages/medusa/src/services/fulfillment-provider.js:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L69)
___
@@ -257,4 +263,4 @@ ___
#### Defined in
[services/fulfillment-provider.js:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L84)
[packages/medusa/src/services/fulfillment-provider.js:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L84)

124
docs/content/references/services/classes/FulfillmentService.md
View File

@@ -1,5 +1,7 @@
# Class: FulfillmentService
Handles Fulfillments
## Hierarchy
- `TransactionBaseService`<[`FulfillmentService`](FulfillmentService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;FulfillmentService\&gt;.constructor
#### Defined in
[services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L47)
[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L47)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;FulfillmentService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### fulfillmentProviderService\_
@@ -54,7 +64,7 @@ ___
#### Defined in
[services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L42)
[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L42)
___
@@ -64,7 +74,7 @@ ___
#### Defined in
[services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L43)
[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L43)
___
@@ -74,7 +84,7 @@ ___
#### Defined in
[services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L45)
[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L45)
___
@@ -84,7 +94,7 @@ ___
#### Defined in
[services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L40)
[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L40)
___
@@ -98,7 +108,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L36)
[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L36)
___
@@ -108,7 +118,7 @@ ___
#### Defined in
[services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L41)
[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L41)
___
@@ -118,7 +128,7 @@ ___
#### Defined in
[services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L39)
[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L39)
___
@@ -128,7 +138,7 @@ ___
#### Defined in
[services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L44)
[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L44)
___
@@ -142,7 +152,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L37)
[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L37)
## Methods
@@ -150,6 +160,10 @@ TransactionBaseService.transactionManager\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -161,21 +175,23 @@ TransactionBaseService.transactionManager\_
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -183,19 +199,25 @@ ___
▸ **cancelFulfillment**(`fulfillmentOrId`): `Promise`<`Fulfillment`\>
Cancels a fulfillment with the fulfillment provider. Will decrement the
fulfillment_quantity on the line items associated with the fulfillment.
Throws if the fulfillment has already been shipped.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `fulfillmentOrId` | `string` \| `Fulfillment` | |
| `fulfillmentOrId` | `string` \| `Fulfillment` | the fulfillment object or id. |
#### Returns
`Promise`<`Fulfillment`\>
the result of the save operation
#### Defined in
[services/fulfillment.ts:254](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L254)
[packages/medusa/src/services/fulfillment.ts:253](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L253)
___
@@ -203,43 +225,55 @@ ___
▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<`Fulfillment`[]\>
Creates an order fulfillment
If items needs to be fulfilled by different provider, we make
sure to partition those items, and create fulfillment for
those partitions.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `CreateFulfillmentOrder` | |
| `itemsToFulfill` | `FulFillmentItemType`[] | |
| `custom` | `Partial`<`Fulfillment`\> | |
| `order` | `CreateFulfillmentOrder` | order to create fulfillment for |
| `itemsToFulfill` | `FulFillmentItemType`[] | the items in the order to fulfill |
| `custom` | `Partial`<`Fulfillment`\> | potential custom values to add |
#### Returns
`Promise`<`Fulfillment`[]\>
the created fulfillments
#### Defined in
[services/fulfillment.ts:199](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L199)
[packages/medusa/src/services/fulfillment.ts:198](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L198)
___
### createShipment
▸ **createShipment**(`fulfillmentId`, `trackingLinks`, `config?`): `Promise`<`Fulfillment`\>
▸ **createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<`Fulfillment`\>
Creates a shipment by marking a fulfillment as shipped. Adds
tracking links and potentially more metadata.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `fulfillmentId` | `string` | |
| `trackingLinks` | { `tracking_number`: `string` }[] | |
| `config` | `CreateShipmentConfig` | |
| `fulfillmentId` | `string` | the fulfillment to ship |
| `trackingLinks?` | { `tracking_number`: `string` }[] | tracking links for the shipment |
| `config` | `CreateShipmentConfig` | potential configuration settings, such as no_notification and metadata |
#### Returns
`Promise`<`Fulfillment`\>
the shipped fulfillment
#### Defined in
[services/fulfillment.ts:304](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L304)
[packages/medusa/src/services/fulfillment.ts:303](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L303)
___
@@ -247,20 +281,24 @@ ___
▸ **getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| `LineItem`)[]\>
Retrieves the order line items, given an array of items.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `CreateFulfillmentOrder` | |
| `items` | `FulFillmentItemType`[] | |
| `order` | `CreateFulfillmentOrder` | the order to get line items from |
| `items` | `FulFillmentItemType`[] | the items to get |
#### Returns
`Promise`<(``null`` \| `LineItem`)[]\>
the line items generated by the transformer.
#### Defined in
[services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L109)
[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L109)
___
@@ -281,7 +319,7 @@ ___
#### Defined in
[services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L71)
[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L71)
___
@@ -289,20 +327,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`Fulfillment`\>
Retrieves a fulfillment by its id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`Fulfillment`\> | |
| `id` | `string` | the id of the fulfillment to retrieve |
| `config` | `FindConfig`<`Fulfillment`\> | optional values to include with fulfillmentRepository query |
#### Returns
`Promise`<`Fulfillment`\>
the fulfillment
#### Defined in
[services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L166)
[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L166)
___
@@ -326,7 +368,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -334,20 +376,28 @@ ___
▸ **validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| `LineItem`
Checks that a given quantity of a line item can be fulfilled. Fails if the
fulfillable quantity is lower than the requested fulfillment quantity.
Fulfillable quantity is calculated by subtracting the already fulfilled
quantity from the quantity that was originally purchased.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `item` | `undefined` \| `LineItem` | |
| `quantity` | `number` | |
| `item` | `undefined` \| `LineItem` | the line item to check has sufficient fulfillable quantity. |
| `quantity` | `number` | the quantity that is requested to be fulfilled. |
#### Returns
``null`` \| `LineItem`
a line item that has the requested fulfillment quantity
set.
#### Defined in
[services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L134)
[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L134)
___
@@ -371,4 +421,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

108
docs/content/references/services/classes/GiftCardService.md
View File

@@ -1,5 +1,7 @@
# Class: GiftCardService
Provides layer to manipulate gift cards.
## Hierarchy
- `TransactionBaseService`<[`GiftCardService`](GiftCardService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;GiftCardService\&gt;.constructor
#### Defined in
[services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L46)
[packages/medusa/src/services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L46)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;GiftCardService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
@@ -54,7 +64,7 @@ ___
#### Defined in
[services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L37)
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L37)
___
@@ -64,7 +74,7 @@ ___
#### Defined in
[services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L34)
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L34)
___
@@ -74,7 +84,7 @@ ___
#### Defined in
[services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L35)
[packages/medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L35)
___
@@ -88,7 +98,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L39)
[packages/medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L39)
___
@@ -98,7 +108,7 @@ ___
#### Defined in
[services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L36)
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L36)
___
@@ -112,7 +122,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L40)
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L40)
___
@@ -128,7 +138,7 @@ ___
#### Defined in
[services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L42)
[packages/medusa/src/services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L42)
## Methods
@@ -136,6 +146,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -147,21 +161,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -169,19 +185,23 @@ ___
▸ **create**(`giftCard`): `Promise`<`GiftCard`\>
Creates a gift card with provided data given that the data is validated.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCard` | `CreateGiftCardInput` | |
| `giftCard` | `CreateGiftCardInput` | the gift card data to create |
#### Returns
`Promise`<`GiftCard`\>
the result of the create operation
#### Defined in
[services/gift-card.ts:155](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L155)
[packages/medusa/src/services/gift-card.ts:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L152)
___
@@ -201,7 +221,7 @@ ___
#### Defined in
[services/gift-card.ts:139](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L139)
[packages/medusa/src/services/gift-card.ts:137](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L137)
___
@@ -209,19 +229,23 @@ ___
▸ **delete**(`giftCardId`): `Promise`<`void` \| `GiftCard`\>
Deletes a gift card idempotently
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCardId` | `string` | |
| `giftCardId` | `string` | id of gift card to delete |
#### Returns
`Promise`<`void` \| `GiftCard`\>
the result of the delete operation
#### Defined in
[services/gift-card.ts:288](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L288)
[packages/medusa/src/services/gift-card.ts:282](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L282)
___
@@ -233,16 +257,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `QuerySelector`<`GiftCard`\> | |
| `config` | `FindConfig`<`GiftCard`\> | |
| `selector` | `QuerySelector`<`GiftCard`\> | the query object for find |
| `config` | `FindConfig`<`GiftCard`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<`GiftCard`[]\>
the result of the find operation
#### Defined in
[services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L114)
[packages/medusa/src/services/gift-card.ts:113](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L113)
___
@@ -254,16 +280,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `QuerySelector`<`GiftCard`\> | |
| `config` | `FindConfig`<`GiftCard`\> | |
| `selector` | `QuerySelector`<`GiftCard`\> | the query object for find |
| `config` | `FindConfig`<`GiftCard`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<[`GiftCard`[], `number`]\>
the result of the find operation
#### Defined in
[services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L84)
[packages/medusa/src/services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L84)
___
@@ -271,20 +299,24 @@ ___
▸ **retrieve**(`giftCardId`, `config?`): `Promise`<`GiftCard`\>
Gets a gift card by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCardId` | `string` | |
| `config` | `FindConfig`<`GiftCard`\> | |
| `giftCardId` | `string` | id of gift card to retrieve |
| `config` | `FindConfig`<`GiftCard`\> | optional values to include with gift card query |
#### Returns
`Promise`<`GiftCard`\>
the gift card
#### Defined in
[services/gift-card.ts:220](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L220)
[packages/medusa/src/services/gift-card.ts:216](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L216)
___
@@ -305,7 +337,7 @@ ___
#### Defined in
[services/gift-card.ts:229](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L229)
[packages/medusa/src/services/gift-card.ts:223](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L223)
___
@@ -326,7 +358,7 @@ ___
#### Defined in
[services/gift-card.ts:185](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L185)
[packages/medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L182)
___
@@ -350,7 +382,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -358,20 +390,24 @@ ___
▸ **update**(`giftCardId`, `update`): `Promise`<`GiftCard`\>
Updates a giftCard.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `giftCardId` | `string` | |
| `update` | `UpdateGiftCardInput` | |
| `giftCardId` | `string` | giftCard id of giftCard to update |
| `update` | `UpdateGiftCardInput` | the data to update the giftCard with |
#### Returns
`Promise`<`GiftCard`\>
the result of the update operation
#### Defined in
[services/gift-card.ts:244](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L244)
[packages/medusa/src/services/gift-card.ts:236](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L236)
___
@@ -395,7 +431,7 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
___
@@ -403,10 +439,14 @@ ___
▸ `Static` **generateCode**(): `string`
Generates a 16 character gift card code
#### Returns
`string`
the generated gift card code
#### Defined in
[services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L68)
[packages/medusa/src/services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L68)

203
docs/content/references/services/classes/IdempotencyKeyService.md
View File

@@ -2,7 +2,7 @@
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`
↳ **`IdempotencyKeyService`**
@@ -20,31 +20,118 @@
#### Overrides
BaseService.constructor
TransactionBaseService.constructor
#### Defined in
[services/idempotency-key.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L8)
[packages/medusa/src/services/idempotency-key.js:8](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L8)
## Properties
### configModule
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `any`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### transactionManager\_
• `Protected` `Abstract` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
## Methods
### create
### atomicPhase\_
▸ **create**(`payload`): `Promise`<`IdempotencyKeyModel`\>
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | `any` | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
### create
▸ **create**(`payload`): `Promise`<`IdempotencyKeyModel`\>
Creates an idempotency key for a request.
If no idempotency key is provided in request, we will create a unique
identifier.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | `any` | payload of request to create idempotency key for |
#### Returns
`Promise`<`IdempotencyKeyModel`\>
the created idempotency key
#### Defined in
[services/idempotency-key.js:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L52)
[packages/medusa/src/services/idempotency-key.js:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L52)
___
@@ -52,22 +139,26 @@ ___
▸ **initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<`IdempotencyKeyModel`\>
Execute the initial steps in a idempotent request.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `headerKey` | `string` | |
| `reqMethod` | `string` | |
| `reqParams` | `string` | |
| `reqPath` | `string` | |
| `headerKey` | `string` | potential idempotency key from header |
| `reqMethod` | `string` | method of request |
| `reqParams` | `string` | params of request |
| `reqPath` | `string` | path of request |
#### Returns
`Promise`<`IdempotencyKeyModel`\>
the existing or created idempotency key
#### Defined in
[services/idempotency-key.js:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L26)
[packages/medusa/src/services/idempotency-key.js:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L26)
___
@@ -75,19 +166,23 @@ ___
▸ **lock**(`idempotencyKey`): `Promise`<`any`\>
Locks an idempotency.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `idempotencyKey` | `string` | |
| `idempotencyKey` | `string` | key to lock |
#### Returns
`Promise`<`any`\>
result of the update operation
#### Defined in
[services/idempotency-key.js:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L90)
[packages/medusa/src/services/idempotency-key.js:90](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L90)
___
@@ -95,19 +190,47 @@ ___
▸ **retrieve**(`idempotencyKey`): `Promise`<`IdempotencyKeyModel`\>
Retrieves an idempotency key
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `idempotencyKey` | `string` | |
| `idempotencyKey` | `string` | key to retrieve |
#### Returns
`Promise`<`IdempotencyKeyModel`\>
idempotency key
#### Defined in
[services/idempotency-key.js:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L73)
[packages/medusa/src/services/idempotency-key.js:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L73)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -115,20 +238,48 @@ ___
▸ **update**(`idempotencyKey`, `update`): `Promise`<`any`\>
Locks an idempotency.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `idempotencyKey` | `string` | |
| `update` | `any` | |
| `idempotencyKey` | `string` | key to update |
| `update` | `any` | update object |
#### Returns
`Promise`<`any`\>
result of the update operation
#### Defined in
[services/idempotency-key.js:117](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L117)
[packages/medusa/src/services/idempotency-key.js:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L117)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): `any`
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
`any`
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
___
@@ -136,17 +287,25 @@ ___
▸ **workStage**(`idempotencyKey`, `func`): `IdempotencyKeyModel`
Performs an atomic work stage.
An atomic work stage contains some related functionality, that needs to be
transactionally executed in isolation. An idempotent request will
always consist of 2 or more of these phases. The required phases are
"started" and "finished".
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `idempotencyKey` | `string` | |
| `func` | `Function` | |
| `idempotencyKey` | `string` | current idempotency key |
| `func` | `Function` | functionality to execute within the phase |
#### Returns
`IdempotencyKeyModel`
new updated idempotency key
#### Defined in
[services/idempotency-key.js:144](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L144)
[packages/medusa/src/services/idempotency-key.js:144](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L144)

175
docs/content/references/services/classes/InventoryService.md
View File

@@ -2,7 +2,7 @@
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`<[`InventoryService`](InventoryService.md)\>
↳ **`InventoryService`**
@@ -16,36 +16,145 @@
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `Object` |
| `__namedParameters` | `InventoryServiceProps` |
#### Overrides
BaseService.constructor
TransactionBaseService&lt;InventoryService\&gt;.constructor
#### Defined in
[services/inventory.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L5)
[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L18)
## Properties
### configModule
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L15)
___
### productVariantService\_
• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md)
#### Defined in
[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L13)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L16)
## Methods
### adjustInventory
▸ **adjustInventory**(`variantId`, `adjustment`): `Promise`<`any`\>
▸ **adjustInventory**(`variantId`, `adjustment`): `Promise`<`undefined` \| `ProductVariant`\>
Updates the inventory of a variant based on a given adjustment.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `adjustment` | `number` | |
| `variantId` | `string` | the id of the variant to update |
| `adjustment` | `number` | the number to adjust the inventory quantity by |
#### Returns
`Promise`<`any`\>
`Promise`<`undefined` \| `ProductVariant`\>
resolves to the update result.
#### Defined in
[services/inventory.js:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L36)
[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L31)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -53,37 +162,71 @@ ___
▸ **confirmInventory**(`variantId`, `quantity`): `Promise`<`boolean`\>
Checks if the inventory of a variant can cover a given quantity. Will
return true if the variant doesn't have managed inventory or if the variant
allows backorders or if the inventory quantity is greater than `quantity`.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `quantity` | `number` | |
| `variantId` | `undefined` \| ``null`` \| `string` | the id of the variant to check |
| `quantity` | `number` | the number of units to check availability for |
#### Returns
`Promise`<`boolean`\>
true if the inventory covers the quantity
#### Defined in
[services/inventory.js:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L62)
[packages/medusa/src/services/inventory.ts:63](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L63)
___
### withTransaction
### shouldRetryTransaction\_
▸ **withTransaction**(`transactionManager`): [`InventoryService`](InventoryService.md)
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `any` |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`InventoryService`](InventoryService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`InventoryService`](InventoryService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[services/inventory.js:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L15)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

73
docs/content/references/services/classes/LineItemService.md
View File

@@ -1,5 +1,7 @@
# Class: LineItemService
Provides layer to manipulate line items.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/line-item.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L44)
[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L44)
## Properties
@@ -34,7 +36,7 @@ BaseService.constructor
#### Defined in
[services/line-item.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L38)
[packages/medusa/src/services/line-item.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L38)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
[services/line-item.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L37)
[packages/medusa/src/services/line-item.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L37)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
[services/line-item.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L42)
[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L42)
___
@@ -64,7 +66,7 @@ ___
#### Defined in
[services/line-item.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L36)
[packages/medusa/src/services/line-item.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L36)
___
@@ -74,7 +76,7 @@ ___
#### Defined in
[services/line-item.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L35)
[packages/medusa/src/services/line-item.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L35)
___
@@ -84,7 +86,7 @@ ___
#### Defined in
[services/line-item.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L40)
[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L40)
___
@@ -94,7 +96,7 @@ ___
#### Defined in
[services/line-item.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L39)
[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L39)
___
@@ -104,7 +106,7 @@ ___
#### Defined in
[services/line-item.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L41)
[packages/medusa/src/services/line-item.ts:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L41)
## Methods
@@ -112,19 +114,23 @@ ___
▸ **create**(`data`): `Promise`<`LineItem`\>
Create a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `Partial`<`LineItem`\> | |
| `data` | `Partial`<`LineItem`\> | the line item object to create |
#### Returns
`Promise`<`LineItem`\>
the created line item
#### Defined in
[services/line-item.ts:270](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L270)
[packages/medusa/src/services/line-item.ts:262](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L262)
___
@@ -132,20 +138,25 @@ ___
▸ **createReturnLines**(`returnId`, `cartId`): `Promise`<`LineItem`[]\>
Creates return line items for a given cart based on the return items in a
return.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `returnId` | `string` | |
| `cartId` | `string` | |
| `returnId` | `string` | the id to generate return items from. |
| `cartId` | `string` | the cart to assign the return line items to. |
#### Returns
`Promise`<`LineItem`[]\>
the created line items
#### Defined in
[services/line-item.ts:142](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L142)
[packages/medusa/src/services/line-item.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L134)
___
@@ -153,19 +164,23 @@ ___
▸ **delete**(`id`): `Promise`<`undefined` \| `LineItem`\>
Deletes a line item.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `id` | `string` | the id of the line item to delete |
#### Returns
`Promise`<`undefined` \| `LineItem`\>
the result of the delete operation
#### Defined in
[services/line-item.ts:318](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L318)
[packages/medusa/src/services/line-item.ts:310](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L310)
___
@@ -192,7 +207,7 @@ ___
#### Defined in
[services/line-item.ts:195](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L195)
[packages/medusa/src/services/line-item.ts:187](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L187)
___
@@ -217,7 +232,7 @@ ___
#### Defined in
[services/line-item.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L90)
[packages/medusa/src/services/line-item.ts:90](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L90)
___
@@ -225,20 +240,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`LineItem`\>
Retrieves a line item by its id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `Object` | |
| `id` | `string` | the id of the line item to retrieve |
| `config` | `Object` | the config to be used at query building |
#### Returns
`Promise`<`LineItem`\>
the line item
#### Defined in
[services/line-item.ts:111](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L111)
[packages/medusa/src/services/line-item.ts:106](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L106)
___
@@ -246,20 +265,24 @@ ___
▸ **update**(`id`, `data`): `Promise`<`LineItem`\>
Updates a line item
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `data` | `Partial`<`LineItem`\> | |
| `id` | `string` | the id of the line item to update |
| `data` | `Partial`<`LineItem`\> | the properties to update on line item |
#### Returns
`Promise`<`LineItem`\>
the update line item
#### Defined in
[services/line-item.ts:289](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L289)
[packages/medusa/src/services/line-item.ts:281](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L281)
___
@@ -279,4 +302,4 @@ ___
#### Defined in
[services/line-item.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L68)
[packages/medusa/src/services/line-item.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L68)

94
docs/content/references/services/classes/MiddlewareService.md
View File

@@ -1,60 +1,56 @@
# Class: MiddlewareService
Orchestrates dynamic middleware registered through the Medusa Middleware API
## Constructors
### constructor
• **new MiddlewareService**(`container`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `container` | `any` |
• **new MiddlewareService**()
#### Defined in
[services/middleware.js:7](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L7)
[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L22)
## Properties
### postAuthentication\_
• **postAuthentication\_**: `any`[]
• `Protected` `Readonly` **postAuthentication\_**: `middlewareType`[]
#### Defined in
[services/middleware.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L8)
[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L17)
___
### preAuthentication\_
• **preAuthentication\_**: `any`[]
• `Protected` `Readonly` **preAuthentication\_**: `middlewareType`[]
#### Defined in
[services/middleware.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L9)
[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L18)
___
### preCartCreation\_
• **preCartCreation\_**: `any`[]
• `Protected` `Readonly` **preCartCreation\_**: `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>[]
#### Defined in
[services/middleware.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L10)
[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L19)
___
### routers
• **routers**: `Object`
• `Protected` `Readonly` **routers**: `Record`<`string`, `Router`[]\>
#### Defined in
[services/middleware.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L11)
[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L20)
## Methods
@@ -62,20 +58,24 @@ ___
▸ **addPostAuthentication**(`middleware`, `options`): `void`
Adds a middleware function to be called after authentication is completed.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `middleware` | `Function` | |
| `options` | `any` | |
| `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. |
| `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware |
#### Returns
`void`
void
#### Defined in
[services/middleware.js:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L45)
[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L60)
___
@@ -83,20 +83,24 @@ ___
▸ **addPreAuthentication**(`middleware`, `options`): `void`
Adds a middleware function to be called before authentication is completed.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `middleware` | `Function` | |
| `options` | `any` | |
| `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. |
| `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware |
#### Returns
`void`
void
#### Defined in
[services/middleware.js:61](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L61)
[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L79)
___
@@ -104,11 +108,13 @@ ___
▸ **addPreCartCreation**(`middleware`): `void`
Adds a middleware function to be called before cart creation
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `middleware` | `Function` | |
| `middleware` | `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> | the middleware function. Should return a middleware function. |
#### Returns
@@ -116,7 +122,7 @@ ___
#### Defined in
[services/middleware.js:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L75)
[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L96)
___
@@ -128,8 +134,8 @@ ___
| Name | Type |
| :------ | :------ |
| `path` | `any` |
| `router` | `any` |
| `path` | `string` |
| `router` | `Router` |
#### Returns
@@ -137,27 +143,27 @@ ___
#### Defined in
[services/middleware.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L14)
[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L29)
___
### getRouters
▸ **getRouters**(`path`): `any`
▸ **getRouters**(`path`): `Router`[]
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `any` |
| `path` | `string` |
#### Returns
`any`
`Router`[]
#### Defined in
[services/middleware.js:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L19)
[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L34)
___
@@ -165,11 +171,13 @@ ___
▸ **usePostAuthentication**(`app`): `void`
Adds post authentication middleware to an express app.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `app` | `ExpressApp` | |
| `app` | `Router` | the express app to add the middleware to |
#### Returns
@@ -177,7 +185,7 @@ ___
#### Defined in
[services/middleware.js:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L85)
[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L106)
___
@@ -185,11 +193,13 @@ ___
▸ **usePreAuthentication**(`app`): `void`
Adds pre authentication middleware to an express app.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `app` | `ExpressApp` | |
| `app` | `Router` | the express app to add the middleware to |
#### Returns
@@ -197,21 +207,21 @@ ___
#### Defined in
[services/middleware.js:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L96)
[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L117)
___
### usePreCartCreation
▸ **usePreCartCreation**(): `any`[]
▸ **usePreCartCreation**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>[]
#### Returns
`any`[]
`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>[]
#### Defined in
[services/middleware.js:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L102)
[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L123)
___
@@ -219,16 +229,20 @@ ___
▸ **validateMiddleware_**(`fn`): `void`
Validates a middleware function, throws if fn is not of type function.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `fn` | `Function` | |
| `fn` | `unknown` | the middleware function to validate. |
#### Returns
`void`
nothing if the middleware is a function
#### Defined in
[services/middleware.js:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L28)
[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L43)

229
docs/content/references/services/classes/NoteService.md
View File

@@ -2,7 +2,7 @@
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`<[`NoteService`](NoteService.md)\>
↳ **`NoteService`**
@@ -16,21 +16,97 @@
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `Object` |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
BaseService.constructor
TransactionBaseService&lt;NoteService\&gt;.constructor
#### Defined in
[services/note.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L12)
[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L29)
## Properties
### configModule
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L27)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L24)
___
### noteRepository\_
• `Protected` `Readonly` **noteRepository\_**: typeof `NoteRepository`
#### Defined in
[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L26)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L25)
___
### Events
▪ `Static` **Events**: `Object`
▪ `Static` `Readonly` **Events**: `Object`
#### Type declaration
@@ -42,48 +118,94 @@ BaseService.constructor
#### Defined in
[services/note.js:6](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L6)
[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L18)
## Methods
### create
### atomicPhase\_
▸ **create**(`data`, `config?`): `Promise`<`any`\>
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateNoteInput` | |
| `config` | `any` | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`any`\>
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[services/note.js:98](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L98)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
### create
▸ **create**(`data`, `config?`): `Promise`<`Note`\>
Creates a note associated with a given author
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateNoteInput` | the note to create |
| `config` | `Object` | any configurations if needed, including meta data |
| `config.metadata` | `Record`<`string`, `unknown`\> | - |
#### Returns
`Promise`<`Note`\>
resolves to the creation result
#### Defined in
[packages/medusa/src/services/note.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L96)
___
### delete
▸ **delete**(`noteId`): `Promise`<`any`\>
▸ **delete**(`noteId`): `Promise`<`void`\>
Deletes a given note
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `noteId` | `any` | |
| `noteId` | `string` | id of the note to delete |
#### Returns
`Promise`<`any`\>
`Promise`<`void`\>
#### Defined in
[services/note.js:154](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L154)
[packages/medusa/src/services/note.ts:154](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L154)
___
@@ -91,23 +213,24 @@ ___
▸ **list**(`selector`, `config?`): `Promise`<`Note`[]\>
Fetches all notes related to the given selector
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `Object` | |
| `config.relations` | `string`[] | |
| `config.skip` | `number` | |
| `config.take` | `number` | |
| `selector` | `Selector`<`Note`\> | the query object for find |
| `config` | `FindConfig`<`Note`\> | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<`Note`[]\>
notes related to the given search.
#### Defined in
[services/note.js:77](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L77)
[packages/medusa/src/services/note.ts:75](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L75)
___
@@ -115,58 +238,94 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`Note`\>
Retrieves a specific note.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `any` | |
| `id` | `string` | the id of the note to retrieve. |
| `config` | `FindConfig`<`Note`\> | any options needed to query for the result. |
#### Returns
`Promise`<`Note`\>
which resolves to the requested note.
#### Defined in
[services/note.js:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L51)
[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L47)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
### update
▸ **update**(`noteId`, `value`): `Promise`<`any`\>
▸ **update**(`noteId`, `value`): `Promise`<`Note`\>
Updates a given note with a new value
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `noteId` | `any` | |
| `value` | `any` | |
| `noteId` | `string` | the id of the note to update |
| `value` | `string` | the new value |
#### Returns
`Promise`<`any`\>
`Promise`<`Note`\>
resolves to the updated element
#### Defined in
[services/note.js:131](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L131)
[packages/medusa/src/services/note.ts:132](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L132)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`NoteService`](NoteService.md)
▸ **withTransaction**(`transactionManager?`): [`NoteService`](NoteService.md)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `transactionManager` | `EntityManager` | |
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`NoteService`](NoteService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[services/note.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L30)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

285
docs/content/references/services/classes/NotificationService.md
View File

@@ -2,7 +2,7 @@
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`<[`NotificationService`](NotificationService.md)\>
↳ **`NotificationService`**
@@ -16,107 +16,222 @@
| Name | Type |
| :------ | :------ |
| `container` | `any` |
| `container` | `InjectedDependencies` |
#### Overrides
BaseService.constructor
TransactionBaseService&lt;NotificationService\&gt;.constructor
#### Defined in
[services/notification.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L9)
[packages/medusa/src/services/notification.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L35)
## Properties
### attachmentGenerator\_
• **attachmentGenerator\_**: `any`
• `Protected` **attachmentGenerator\_**: `unknown` = `null`
#### Defined in
[services/notification.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L30)
[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L27)
___
### configModule
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### container\_
• **container\_**: `any`
• `Protected` `Readonly` **container\_**: `InjectedDependencies` & {}
#### Defined in
[services/notification.js:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L19)
[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L28)
___
### logger\_
• **logger\_**: `any`
• `Protected` `Readonly` **logger\_**: `Logger`
#### Defined in
[services/notification.js:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L23)
[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L31)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L23)
___
### notificationProviderRepository\_
• **notificationProviderRepository\_**: `any`
• `Protected` `Readonly` **notificationProviderRepository\_**: typeof `NotificationProviderRepository`
#### Defined in
[services/notification.js:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L27)
[packages/medusa/src/services/notification.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L33)
___
### notificationRepository\_
• `Protected` `Readonly` **notificationRepository\_**: typeof `NotificationRepository`
#### Defined in
[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L32)
___
### subscribers\_
• **subscribers\_**: `Object`
• `Protected` **subscribers\_**: `Object` = `{}`
#### Defined in
[services/notification.js:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L29)
[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L26)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L24)
## Methods
### handleEvent
### atomicPhase\_
▸ **handleEvent**(`eventName`, `data`): `Promise`<`any`\>
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | |
| `data` | `any` | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`any`\>
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[services/notification.js:166](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L166)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
### handleEvent
▸ **handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| `Notification`[]\>
Handles an event by relaying the event data to the subscribing providers.
The result of the notification send will be persisted in the database in
order to allow for resends. Will log any errors that are encountered.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | the event to handle |
| `data` | `Record`<`string`, `unknown`\> | the data the event was sent with |
#### Returns
`Promise`<`undefined` \| `void` \| `Notification`[]\>
the result of notification subscribed
#### Defined in
[packages/medusa/src/services/notification.ts:173](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L173)
___
### list
▸ **list**(`selector`, `config?`): `Notification`[]
▸ **list**(`selector`, `config?`): `Promise`<`Notification`[]\>
Retrieves a list of notifications.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `Selector`<`Notification`\> | the params to select the notifications by. |
| `config` | `FindConfig`<`Notification`\> | the configuration to apply to the query |
#### Returns
`Notification`[]
`Promise`<`Notification`[]\>
the notifications that satisfy the query.
#### Defined in
[services/notification.js:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L84)
[packages/medusa/src/services/notification.ts:85](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L85)
___
@@ -124,11 +239,14 @@ ___
▸ **registerAttachmentGenerator**(`service`): `void`
Registers an attachment generator to the service. The generator can be
used to generate on demand invoices or other documents.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `service` | `any` | |
| `service` | `unknown` | the service to assign to the attachmentGenerator |
#### Returns
@@ -136,19 +254,21 @@ ___
#### Defined in
[services/notification.js:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L38)
[packages/medusa/src/services/notification.ts:61](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L61)
___
### registerInstalledProviders
▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\>
▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\>
Takes a list of notification provider ids and persists them in the database.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `providers` | `string`[] | |
| `providerIds` | `string`[] | a list of provider ids |
#### Returns
@@ -156,91 +276,134 @@ ___
#### Defined in
[services/notification.js:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L68)
[packages/medusa/src/services/notification.ts:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L69)
___
### resend
▸ **resend**(`id`, `config?`): `Notification`
▸ **resend**(`id`, `config?`): `Promise`<`Notification`\>
Resends a notification by retrieving a prior notification and calling the
underlying provider's resendNotification method.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `any` | |
| `id` | `string` | the id of the notification |
| `config` | `FindConfig`<`Notification`\> | any configuration that might override the previous send |
#### Returns
`Notification`
`Promise`<`Notification`\>
the newly created notification
#### Defined in
[services/notification.js:237](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L237)
[packages/medusa/src/services/notification.ts:253](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L253)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Notification`
▸ **retrieve**(`id`, `config?`): `Promise`<`Notification`\>
Retrieves a notification with a given id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `any` | |
| `id` | `string` | the id of the notification |
| `config` | `FindConfig`<`Notification`\> | the configuration to apply to the query |
#### Returns
`Notification`
`Promise`<`Notification`\>
the notification
#### Defined in
[services/notification.js:101](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L101)
[packages/medusa/src/services/notification.ts:106](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L106)
___
### retrieveProvider\_
▸ **retrieveProvider_**(`id`): `NotificationProvider`
▸ `Protected` **retrieveProvider_**(`id`): `AbstractNotificationService`<`never`\>
Finds a provider with a given id. Will throw a NOT_FOUND error if the
resolution fails.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `id` | `string` | the id of the provider |
#### Returns
`NotificationProvider`
`AbstractNotificationService`<`never`\>
the notification provider
#### Defined in
[services/notification.js:147](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L147)
[packages/medusa/src/services/notification.ts:154](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L154)
___
### send
▸ **send**(`event`, `eventData`, `providerId`): `Notification`
▸ **send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| `Notification`\>
Sends a notification, by calling the given provider's sendNotification
method. Persists the Notification in the database.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `event` | `string` | |
| `eventData` | `any` | |
| `providerId` | `string` | |
| `event` | `string` | the name of the event |
| `eventData` | `Record`<`string`, `unknown`\> | the data the event was sent with |
| `providerId` | `string` | the provider that should hande the event. |
#### Returns
`Notification`
`Promise`<`undefined` \| `Notification`\>
the created notification
#### Defined in
[services/notification.js:195](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L195)
[packages/medusa/src/services/notification.ts:205](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L205)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -248,12 +411,14 @@ ___
▸ **subscribe**(`eventName`, `providerId`): `void`
Subscribes a given provider to an event.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | |
| `providerId` | `string` | |
| `eventName` | `string` | the event to subscribe to |
| `providerId` | `string` | the provider that the event will be sent to |
#### Returns
@@ -261,24 +426,28 @@ ___
#### Defined in
[services/notification.js:126](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L126)
[packages/medusa/src/services/notification.ts:133](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L133)
___
### withTransaction
▸ **withTransaction**(`transactionManager`): [`NotificationService`](NotificationService.md)
▸ **withTransaction**(`transactionManager?`): [`NotificationService`](NotificationService.md)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `transactionManager` | `EntityManager` | |
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`NotificationService`](NotificationService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[services/notification.js:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L47)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

26
docs/content/references/services/classes/OauthService.md
View File

@@ -24,7 +24,7 @@ OauthService.constructor
#### Defined in
[services/oauth.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L10)
[packages/medusa/src/services/oauth.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L10)
## Properties
@@ -34,7 +34,7 @@ OauthService.constructor
#### Defined in
[services/oauth.js:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L15)
[packages/medusa/src/services/oauth.js:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L15)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
[services/oauth.js:17](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L17)
[packages/medusa/src/services/oauth.js:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L17)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
[services/oauth.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L14)
[packages/medusa/src/services/oauth.js:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L14)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[services/oauth.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L16)
[packages/medusa/src/services/oauth.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L16)
___
@@ -81,7 +81,7 @@ ___
#### Defined in
[services/oauth.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L5)
[packages/medusa/src/services/oauth.js:5](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L5)
## Methods
@@ -101,7 +101,7 @@ ___
#### Defined in
[services/oauth.js:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L32)
[packages/medusa/src/services/oauth.js:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L32)
___
@@ -123,7 +123,7 @@ ___
#### Defined in
[services/oauth.js:66](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L66)
[packages/medusa/src/services/oauth.js:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L66)
___
@@ -143,7 +143,7 @@ ___
#### Defined in
[services/oauth.js:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L27)
[packages/medusa/src/services/oauth.js:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L27)
___
@@ -163,7 +163,7 @@ ___
#### Defined in
[services/oauth.js:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L96)
[packages/medusa/src/services/oauth.js:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L96)
___
@@ -183,7 +183,7 @@ ___
#### Defined in
[services/oauth.js:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L56)
[packages/medusa/src/services/oauth.js:56](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L56)
___
@@ -203,7 +203,7 @@ ___
#### Defined in
[services/oauth.js:20](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L20)
[packages/medusa/src/services/oauth.js:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L20)
___
@@ -224,4 +224,4 @@ ___
#### Defined in
[services/oauth.js:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L45)
[packages/medusa/src/services/oauth.js:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L45)

1083
docs/content/references/services/classes/OrderService.md
View File

File diff suppressed because it is too large Load Diff

83
docs/content/references/services/classes/PaymentProviderService.md
View File

@@ -1,5 +1,7 @@
# Class: PaymentProviderService
Helps retrive payment providers
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/payment-provider.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L8)
[packages/medusa/src/services/payment-provider.js:8](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L8)
## Properties
@@ -34,7 +36,7 @@ BaseService.constructor
#### Defined in
[services/payment-provider.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L14)
[packages/medusa/src/services/payment-provider.js:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L14)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
[services/payment-provider.js:18](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L18)
[packages/medusa/src/services/payment-provider.js:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L18)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
[services/payment-provider.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L16)
[packages/medusa/src/services/payment-provider.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L16)
___
@@ -64,7 +66,7 @@ ___
#### Defined in
[services/payment-provider.js:20](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L20)
[packages/medusa/src/services/payment-provider.js:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L20)
## Methods
@@ -85,7 +87,7 @@ ___
#### Defined in
[services/payment-provider.js:283](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L283)
[packages/medusa/src/services/payment-provider.js:283](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L283)
___
@@ -105,7 +107,7 @@ ___
#### Defined in
[services/payment-provider.js:324](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L324)
[packages/medusa/src/services/payment-provider.js:324](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L324)
___
@@ -125,7 +127,7 @@ ___
#### Defined in
[services/payment-provider.js:343](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L343)
[packages/medusa/src/services/payment-provider.js:343](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L343)
___
@@ -145,7 +147,7 @@ ___
#### Defined in
[services/payment-provider.js:246](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L246)
[packages/medusa/src/services/payment-provider.js:246](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L246)
___
@@ -153,20 +155,24 @@ ___
▸ **createSession**(`providerId`, `cart`): `Promise`<`any`\>
Creates a payment session with the given provider.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `providerId` | `string` | |
| `cart` | `Cart` | |
| `providerId` | `string` | the id of the provider to create payment with |
| `cart` | `Cart` | a cart object used to calculate the amount, etc. from |
#### Returns
`Promise`<`any`\>
the payment session
#### Defined in
[services/payment-provider.js:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L121)
[packages/medusa/src/services/payment-provider.js:121](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L121)
___
@@ -186,7 +192,7 @@ ___
#### Defined in
[services/payment-provider.js:202](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L202)
[packages/medusa/src/services/payment-provider.js:202](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L202)
___
@@ -206,7 +212,7 @@ ___
#### Defined in
[services/payment-provider.js:338](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L338)
[packages/medusa/src/services/payment-provider.js:338](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L338)
___
@@ -220,7 +226,7 @@ ___
#### Defined in
[services/payment-provider.js:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L47)
[packages/medusa/src/services/payment-provider.js:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L47)
___
@@ -245,7 +251,7 @@ ___
#### Defined in
[services/payment-provider.js:80](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L80)
[packages/medusa/src/services/payment-provider.js:80](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L80)
___
@@ -253,20 +259,25 @@ ___
▸ **refreshSession**(`paymentSession`, `cart`): `Promise`<`any`\>
Refreshes a payment session with the given provider.
This means, that we delete the current one and create a new.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `paymentSession` | `PaymentSession` | |
| `cart` | `Cart` | |
| `paymentSession` | `PaymentSession` | the payment session object to update |
| `cart` | `Cart` | a cart object used to calculate the amount, etc. from |
#### Returns
`Promise`<`any`\>
the payment session
#### Defined in
[services/payment-provider.js:152](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L152)
[packages/medusa/src/services/payment-provider.js:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L152)
___
@@ -289,7 +300,7 @@ ___
#### Defined in
[services/payment-provider.js:358](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L358)
[packages/medusa/src/services/payment-provider.js:358](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L358)
___
@@ -309,7 +320,7 @@ ___
#### Defined in
[services/payment-provider.js:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L35)
[packages/medusa/src/services/payment-provider.js:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L35)
___
@@ -330,7 +341,7 @@ ___
#### Defined in
[services/payment-provider.js:54](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L54)
[packages/medusa/src/services/payment-provider.js:54](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L54)
___
@@ -338,19 +349,23 @@ ___
▸ **retrieveProvider**(`providerId`): `PaymentService`
Finds a provider given an id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `providerId` | `string` | |
| `providerId` | `string` | the id of the provider to get |
#### Returns
`PaymentService`
the payment provider
#### Defined in
[services/payment-provider.js:228](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L228)
[packages/medusa/src/services/payment-provider.js:228](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L228)
___
@@ -371,7 +386,7 @@ ___
#### Defined in
[services/payment-provider.js:422](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L422)
[packages/medusa/src/services/payment-provider.js:422](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L422)
___
@@ -392,7 +407,7 @@ ___
#### Defined in
[services/payment-provider.js:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L89)
[packages/medusa/src/services/payment-provider.js:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L89)
___
@@ -413,7 +428,7 @@ ___
#### Defined in
[services/payment-provider.js:266](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L266)
[packages/medusa/src/services/payment-provider.js:266](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L266)
___
@@ -421,20 +436,24 @@ ___
▸ **updateSession**(`paymentSession`, `cart`): `Promise`<`any`\>
Updates an existing payment session.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `paymentSession` | `PaymentSession` | |
| `cart` | `Cart` | |
| `paymentSession` | `PaymentSession` | the payment session object to update |
| `cart` | `Cart` | the cart object to update for |
#### Returns
`Promise`<`any`\>
the updated payment session
#### Defined in
[services/payment-provider.js:188](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L188)
[packages/medusa/src/services/payment-provider.js:188](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L188)
___
@@ -455,7 +474,7 @@ ___
#### Defined in
[services/payment-provider.js:308](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L308)
[packages/medusa/src/services/payment-provider.js:308](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L308)
___
@@ -475,4 +494,4 @@ ___
#### Defined in
[services/payment-provider.js:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L23)
[packages/medusa/src/services/payment-provider.js:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L23)

146
docs/content/references/services/classes/PricingService.md
View File

@@ -1,5 +1,7 @@
# Class: PricingService
Allows retrieval of prices.
## Hierarchy
- `TransactionBaseService`<[`PricingService`](PricingService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;PricingService\&gt;.constructor
#### Defined in
[services/pricing.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L40)
[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L40)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;PricingService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### manager\_
@@ -58,7 +68,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/pricing.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L33)
[packages/medusa/src/services/pricing.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L33)
___
@@ -68,7 +78,7 @@ ___
#### Defined in
[services/pricing.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L37)
[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L37)
___
@@ -78,7 +88,7 @@ ___
#### Defined in
[services/pricing.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L38)
[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L38)
___
@@ -88,7 +98,7 @@ ___
#### Defined in
[services/pricing.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L35)
[packages/medusa/src/services/pricing.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L35)
___
@@ -98,7 +108,7 @@ ___
#### Defined in
[services/pricing.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L36)
[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L36)
___
@@ -112,7 +122,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/pricing.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L34)
[packages/medusa/src/services/pricing.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L34)
## Methods
@@ -120,6 +130,10 @@ TransactionBaseService.transactionManager\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -131,21 +145,23 @@ TransactionBaseService.transactionManager\_
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -153,20 +169,24 @@ ___
▸ **calculateTaxes**(`variantPricing`, `productRates`): `Promise`<`TaxedPricing`\>
Gets the prices for a product variant
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantPricing` | `ProductVariantPricing` | |
| `productRates` | `TaxServiceRate`[] | |
| `variantPricing` | `ProductVariantPricing` | the prices retrieved from a variant |
| `productRates` | `TaxServiceRate`[] | the tax rates that the product has applied |
#### Returns
`Promise`<`TaxedPricing`\>
The tax related variant prices.
#### Defined in
[services/pricing.ts:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L102)
[packages/medusa/src/services/pricing.ts:98](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L98)
___
@@ -174,19 +194,24 @@ ___
▸ **collectPricingContext**(`context`): `Promise`<`PricingContext`\>
Collects additional information neccessary for completing the price
selection.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `context` | `PriceSelectionContext` | |
| `context` | `PriceSelectionContext` | the price selection context to use |
#### Returns
`Promise`<`PricingContext`\>
The pricing context
#### Defined in
[services/pricing.ts:63](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L63)
[packages/medusa/src/services/pricing.ts:63](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L63)
___
@@ -194,20 +219,25 @@ ___
▸ **getProductPricing**(`product`, `context`): `Promise`<`Record`<`string`, `ProductVariantPricing`\>\>
Gets all the variant prices for a product. All the product's variants will
be fetched.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `product` | `Pick`<`Product`, ``"id"`` \| ``"variants"``\> | |
| `context` | `PriceSelectionContext` | |
| `product` | `Pick`<`Product`, ``"id"`` \| ``"variants"``\> | the product to get pricing for. |
| `context` | `PriceSelectionContext` | the price selection context to use |
#### Returns
`Promise`<`Record`<`string`, `ProductVariantPricing`\>\>
A map of variant ids to their corresponding prices
#### Defined in
[services/pricing.ts:292](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L292)
[packages/medusa/src/services/pricing.ts:286](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L286)
___
@@ -215,20 +245,24 @@ ___
▸ **getProductPricingById**(`productId`, `context`): `Promise`<`Record`<`string`, `ProductVariantPricing`\>\>
Gets all the variant prices for a product by the product id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `context` | `PriceSelectionContext` | |
| `productId` | `string` | the id of the product to get prices for |
| `context` | `PriceSelectionContext` | the price selection context to use |
#### Returns
`Promise`<`Record`<`string`, `ProductVariantPricing`\>\>
A map of variant ids to their corresponding prices
#### Defined in
[services/pricing.ts:310](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L310)
[packages/medusa/src/services/pricing.ts:304](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L304)
___
@@ -250,7 +284,7 @@ ___
#### Defined in
[services/pricing.ts:254](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L254)
[packages/medusa/src/services/pricing.ts:248](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L248)
___
@@ -258,20 +292,24 @@ ___
▸ **getProductVariantPricing**(`variant`, `context`): `Promise`<`ProductVariantPricing`\>
Gets the prices for a product variant.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variant` | `Pick`<`ProductVariant`, ``"id"`` \| ``"product_id"``\> | |
| `context` | `PriceSelectionContext` \| `PricingContext` | |
| `variant` | `Pick`<`ProductVariant`, ``"id"`` \| ``"product_id"``\> | the id of the variant to get prices for |
| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use |
#### Returns
`Promise`<`ProductVariantPricing`\>
The product variant prices
#### Defined in
[services/pricing.ts:180](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L180)
[packages/medusa/src/services/pricing.ts:176](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L176)
___
@@ -279,20 +317,24 @@ ___
▸ **getProductVariantPricingById**(`variantId`, `context`): `Promise`<`ProductVariantPricing`\>
Gets the prices for a product variant by a variant id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `context` | `PriceSelectionContext` \| `PricingContext` | |
| `variantId` | `string` | the id of the variant to get prices for |
| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use |
#### Returns
`Promise`<`ProductVariantPricing`\>
The product variant prices
#### Defined in
[services/pricing.ts:218](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L218)
[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L214)
___
@@ -314,7 +356,7 @@ ___
#### Defined in
[services/pricing.ts:138](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L138)
[packages/medusa/src/services/pricing.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L134)
___
@@ -322,20 +364,24 @@ ___
▸ **getShippingOptionPricing**(`shippingOption`, `context`): `Promise`<`PricedShippingOption`\>
Gets the prices for a shipping option.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `shippingOption` | `ShippingOption` | |
| `context` | `PriceSelectionContext` \| `PricingContext` | |
| `shippingOption` | `ShippingOption` | the shipping option to get prices for |
| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use |
#### Returns
`Promise`<`PricedShippingOption`\>
The shipping option prices
#### Defined in
[services/pricing.ts:396](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L396)
[packages/medusa/src/services/pricing.ts:390](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L390)
___
@@ -343,20 +389,24 @@ ___
▸ **setProductPrices**(`products`, `context?`): `Promise`<(`Product` \| `PricedProduct`)[]\>
Set additional prices on a list of products.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `products` | `Product`[] | |
| `context` | `PriceSelectionContext` | |
| `products` | `Product`[] | list of products on which to set additional prices |
| `context` | `PriceSelectionContext` | the price selection context to use |
#### Returns
`Promise`<(`Product` \| `PricedProduct`)[]\>
A list of products with variants decorated with prices
#### Defined in
[services/pricing.ts:353](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L353)
[packages/medusa/src/services/pricing.ts:347](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L347)
___
@@ -364,20 +414,24 @@ ___
▸ **setShippingOptionPrices**(`shippingOptions`, `context?`): `Promise`<`PricedShippingOption`[]\>
Set additional prices on a list of shipping options.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `shippingOptions` | `ShippingOption`[] | |
| `context` | `Omit`<`PriceSelectionContext`, ``"region_id"``\> | |
| `shippingOptions` | `ShippingOption`[] | list of shipping options on which to set additional prices |
| `context` | `Omit`<`PriceSelectionContext`, ``"region_id"``\> | the price selection context to use |
#### Returns
`Promise`<`PricedShippingOption`[]\>
A list of shipping options with prices
#### Defined in
[services/pricing.ts:445](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L445)
[packages/medusa/src/services/pricing.ts:437](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L437)
___
@@ -385,20 +439,24 @@ ___
▸ **setVariantPrices**(`variants`, `context`): `Promise`<`PricedVariant`[]\>
Set additional prices on a list of product variants.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variants` | `ProductVariant`[] | |
| `context` | `PriceSelectionContext` | |
| `variants` | `ProductVariant`[] | list of variants on which to set additional prices |
| `context` | `PriceSelectionContext` | the price selection context to use |
#### Returns
`Promise`<`PricedVariant`[]\>
A list of products with variants decorated with prices
#### Defined in
[services/pricing.ts:328](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L328)
[packages/medusa/src/services/pricing.ts:322](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L322)
___
@@ -422,7 +480,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -446,4 +504,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

76
docs/content/references/services/classes/ProductCollectionService.md
View File

@@ -1,5 +1,7 @@
# Class: ProductCollectionService
Provides layer to manipulate product collections.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/product-collection.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L11)
[packages/medusa/src/services/product-collection.js:11](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L11)
## Methods
@@ -45,7 +47,7 @@ BaseService.constructor
#### Defined in
[services/product-collection.js:170](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L170)
[packages/medusa/src/services/product-collection.js:170](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L170)
___
@@ -53,19 +55,23 @@ ___
▸ **create**(`collection`): `Promise`<`ProductCollection`\>
Creates a product collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collection` | `any` | |
| `collection` | `any` | the collection to create |
#### Returns
`Promise`<`ProductCollection`\>
created collection
#### Defined in
[services/product-collection.js:104](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L104)
[packages/medusa/src/services/product-collection.js:104](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L104)
___
@@ -73,19 +79,23 @@ ___
▸ **delete**(`collectionId`): `Promise`<`any`\>
Deletes a product collection idempotently
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionId` | `string` | |
| `collectionId` | `string` | id of collection to delete |
#### Returns
`Promise`<`any`\>
empty promise
#### Defined in
[services/product-collection.js:152](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L152)
[packages/medusa/src/services/product-collection.js:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L152)
___
@@ -93,20 +103,24 @@ ___
▸ **list**(`selector?`, `config?`): `Promise`<`any`\>
Lists product collections
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | the query object for find |
| `config` | `any` | the config to be used for find |
#### Returns
`Promise`<`any`\>
the result of the find operation
#### Defined in
[services/product-collection.js:206](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L206)
[packages/medusa/src/services/product-collection.js:206](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L206)
___
@@ -114,20 +128,24 @@ ___
▸ **listAndCount**(`selector?`, `config?`): `Promise`<`any`\>
Lists product collections and add count.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | the query object for find |
| `config` | `any` | the config to be used for find |
#### Returns
`Promise`<`any`\>
the result of the find operation
#### Defined in
[services/product-collection.js:221](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L221)
[packages/medusa/src/services/product-collection.js:221](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L221)
___
@@ -148,7 +166,7 @@ ___
#### Defined in
[services/product-collection.js:188](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L188)
[packages/medusa/src/services/product-collection.js:188](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L188)
___
@@ -156,20 +174,24 @@ ___
▸ **retrieve**(`collectionId`, `config?`): `Promise`<`ProductCollection`\>
Retrieves a product collection by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionId` | `string` | |
| `config` | `any` | |
| `collectionId` | `string` | the id of the collection to retrieve. |
| `config` | `any` | the config of the collection to retrieve. |
#### Returns
`Promise`<`ProductCollection`\>
the collection.
#### Defined in
[services/product-collection.js:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L55)
[packages/medusa/src/services/product-collection.js:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L55)
___
@@ -177,20 +199,24 @@ ___
▸ **retrieveByHandle**(`collectionHandle`, `config?`): `Promise`<`ProductCollection`\>
Retrieves a product collection by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionHandle` | `string` | |
| `config` | `any` | |
| `collectionHandle` | `string` | the handle of the collection to retrieve. |
| `config` | `any` | query config for request |
#### Returns
`Promise`<`ProductCollection`\>
the collection.
#### Defined in
[services/product-collection.js:81](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L81)
[packages/medusa/src/services/product-collection.js:81](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L81)
___
@@ -198,20 +224,24 @@ ___
▸ **update**(`collectionId`, `update`): `Promise`<`ProductCollection`\>
Updates a product collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionId` | `string` | |
| `update` | `any` | |
| `collectionId` | `string` | id of collection to update |
| `update` | `any` | update object |
#### Returns
`Promise`<`ProductCollection`\>
update collection
#### Defined in
[services/product-collection.js:125](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L125)
[packages/medusa/src/services/product-collection.js:125](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L125)
___
@@ -231,4 +261,4 @@ ___
#### Defined in
[services/product-collection.js:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L32)
[packages/medusa/src/services/product-collection.js:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L32)

269
docs/content/references/services/classes/ProductService.md
View File

@@ -2,7 +2,7 @@
## Hierarchy
- `TransactionBaseService`<[`ProductService`](ProductService.md)\>
- `TransactionBaseService`<[`ProductService`](ProductService.md), `InjectedDependencies`\>
↳ **`ProductService`**
@@ -20,11 +20,14 @@
#### Overrides
TransactionBaseService&lt;ProductService\&gt;.constructor
TransactionBaseService&lt;
ProductService,
InjectedDependencies
\&gt;.constructor
#### Defined in
[services/product.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L62)
[packages/medusa/src/services/product.ts:75](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L75)
## Properties
@@ -36,16 +39,24 @@ TransactionBaseService&lt;ProductService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
• `Protected` `Readonly` **container**: `InjectedDependencies`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
@@ -54,7 +65,17 @@ ___
#### Defined in
[services/product.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L53)
[packages/medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L65)
___
### featureFlagRouter\_
• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`
#### Defined in
[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L66)
___
@@ -64,7 +85,7 @@ ___
#### Defined in
[services/product.ts:50](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L50)
[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L62)
___
@@ -78,7 +99,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/product.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L42)
[packages/medusa/src/services/product.ts:54](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L54)
___
@@ -88,7 +109,7 @@ ___
#### Defined in
[services/product.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L45)
[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L57)
___
@@ -98,7 +119,7 @@ ___
#### Defined in
[services/product.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L46)
[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L58)
___
@@ -108,7 +129,7 @@ ___
#### Defined in
[services/product.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L49)
[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L61)
___
@@ -118,7 +139,7 @@ ___
#### Defined in
[services/product.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L48)
[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L60)
___
@@ -128,7 +149,7 @@ ___
#### Defined in
[services/product.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L47)
[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L59)
___
@@ -138,7 +159,7 @@ ___
#### Defined in
[services/product.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L51)
[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L63)
___
@@ -148,7 +169,7 @@ ___
#### Defined in
[services/product.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L52)
[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L64)
___
@@ -162,7 +183,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/product.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L43)
[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L55)
___
@@ -180,7 +201,7 @@ ___
#### Defined in
[services/product.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L56)
[packages/medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L69)
___
@@ -190,7 +211,7 @@ ___
#### Defined in
[services/product.ts:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L55)
[packages/medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L68)
## Methods
@@ -198,20 +219,26 @@ ___
▸ **addOption**(`productId`, `optionTitle`): `Promise`<`Product`\>
Adds an option to a product. Options can, for example, be "Size", "Color",
etc. Will update all the products variants with a dummy value for the newly
created option. The same option cannot be added more than once.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `optionTitle` | `string` | |
| `productId` | `string` | the product to apply the new option to |
| `optionTitle` | `string` | the display title of the option, e.g. "Size" |
#### Returns
`Promise`<`Product`\>
the result of the model update operation
#### Defined in
[services/product.ts:552](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L552)
[packages/medusa/src/services/product.ts:637](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L637)
___
@@ -219,6 +246,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -230,21 +261,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -252,19 +285,23 @@ ___
▸ **count**(`selector?`): `Promise`<`number`\>
Return the total number of documents in database
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> | |
| `selector` | `Selector`<`Product`\> | the selector to choose products by |
#### Returns
`Promise`<`number`\>
the result of the count operation
#### Defined in
[services/product.ts:175](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L175)
[packages/medusa/src/services/product.ts:178](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L178)
___
@@ -272,19 +309,23 @@ ___
▸ **create**(`productObject`): `Promise`<`Product`\>
Creates a product.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productObject` | `CreateProductInput` | |
| `productObject` | `CreateProductInput` | the product to create |
#### Returns
`Promise`<`Product`\>
resolves to the creation result.
#### Defined in
[services/product.ts:324](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L324)
[packages/medusa/src/services/product.ts:346](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L346)
___
@@ -292,19 +333,24 @@ ___
▸ **delete**(`productId`): `Promise`<`void`\>
Deletes a product from a given product id. The product's associated
variants will also be deleted.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `productId` | `string` | the id of the product to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[services/product.ts:518](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L518)
[packages/medusa/src/services/product.ts:603](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L603)
___
@@ -312,33 +358,38 @@ ___
▸ **deleteOption**(`productId`, `optionId`): `Promise`<`void` \| `Product`\>
Delete an option from a product.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `optionId` | `string` | |
| `productId` | `string` | the product to delete an option from |
| `optionId` | `string` | the option to delete |
#### Returns
`Promise`<`void` \| `Product`\>
the updated product
#### Defined in
[services/product.ts:693](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L693)
[packages/medusa/src/services/product.ts:778](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L778)
___
### list
### filterProductsBySalesChannel
▸ **list**(`selector?`, `config?`): `Promise`<`Product`[]\>
▸ **filterProductsBySalesChannel**(`productIds`, `salesChannelId`, `config?`): `Promise`<`Product`[]\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | |
| `config` | `FindProductConfig` | |
| Name | Type |
| :------ | :------ |
| `productIds` | `string`[] |
| `salesChannelId` | `string` |
| `config` | `FindProductConfig` |
#### Returns
@@ -346,7 +397,32 @@ ___
#### Defined in
[services/product.ts:107](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L107)
[packages/medusa/src/services/product.ts:292](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L292)
___
### list
▸ **list**(`selector?`, `config?`): `Promise`<`Product`[]\>
Lists products based on the provided parameters.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | an object that defines rules to filter products by |
| `config` | `FindProductConfig` | object that defines the scope for what should be returned |
#### Returns
`Promise`<`Product`[]\>
the result of the find operation
#### Defined in
[packages/medusa/src/services/product.ts:112](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L112)
___
@@ -354,20 +430,27 @@ ___
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Product`[], `number`]\>
Lists products based on the provided parameters and includes the count of
products that match the query.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | |
| `config` | `FindProductConfig` | |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | an object that defines rules to filter products by |
| `config` | `FindProductConfig` | object that defines the scope for what should be returned |
#### Returns
`Promise`<[`Product`[], `number`]\>
an array containing the products as
the first element and the total count of products that matches the query
as the second element.
#### Defined in
[services/product.ts:144](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L144)
[packages/medusa/src/services/product.ts:148](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L148)
___
@@ -387,7 +470,7 @@ ___
#### Defined in
[services/product.ts:309](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L309)
[packages/medusa/src/services/product.ts:332](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L332)
___
@@ -401,7 +484,7 @@ ___
#### Defined in
[services/product.ts:299](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L299)
[packages/medusa/src/services/product.ts:323](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L323)
___
@@ -409,17 +492,22 @@ ___
▸ `Protected` **prepareListQuery_**(`selector`, `config`): `Object`
Creates a query object to be used for list queries.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | |
| `config` | `FindProductConfig` | |
| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | the selector to create the query from |
| `config` | `FindProductConfig` | the config to use for the query |
#### Returns
`Object`
an object containing the query, relations and free-text
search param.
| Name | Type |
| :------ | :------ |
| `q` | `string` |
@@ -428,7 +516,7 @@ ___
#### Defined in
[services/product.ts:759](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L759)
[packages/medusa/src/services/product.ts:844](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L844)
___
@@ -449,7 +537,7 @@ ___
#### Defined in
[services/product.ts:591](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L591)
[packages/medusa/src/services/product.ts:676](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L676)
___
@@ -457,20 +545,25 @@ ___
▸ **retrieve**(`productId`, `config?`): `Promise`<`Product`\>
Gets a product by id.
Throws in case of DB Error and if product was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `config` | `FindProductConfig` | |
| `productId` | `string` | id of the product to get. |
| `config` | `FindProductConfig` | object that defines what should be included in the query response |
#### Returns
`Promise`<`Product`\>
the result of the find one operation.
#### Defined in
[services/product.ts:191](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L191)
[packages/medusa/src/services/product.ts:193](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L193)
___
@@ -478,20 +571,25 @@ ___
▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<`Product`\>
Gets a product by external id.
Throws in case of DB Error and if product was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `externalId` | `string` | |
| `config` | `FindProductConfig` | |
| `externalId` | `string` | handle of the product to get. |
| `config` | `FindProductConfig` | details about what to get from the product |
#### Returns
`Promise`<`Product`\>
the result of the find one operation.
#### Defined in
[services/product.ts:225](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L225)
[packages/medusa/src/services/product.ts:223](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L223)
___
@@ -499,20 +597,25 @@ ___
▸ **retrieveByHandle**(`productHandle`, `config?`): `Promise`<`Product`\>
Gets a product by handle.
Throws in case of DB Error and if product was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productHandle` | `string` | |
| `config` | `FindProductConfig` | |
| `productHandle` | `string` | handle of the product to get. |
| `config` | `FindProductConfig` | details about what to get from the product |
#### Returns
`Promise`<`Product`\>
the result of the find one operation.
#### Defined in
[services/product.ts:209](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L209)
[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L209)
___
@@ -520,20 +623,24 @@ ___
▸ **retrieveVariants**(`productId`, `config?`): `Promise`<`ProductVariant`[]\>
Gets all variants belonging to a product.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `config` | `FindProductConfig` | |
| `productId` | `string` | the id of the product to get variants from. |
| `config` | `FindProductConfig` | The config to select and configure relations etc... |
#### Returns
`Promise`<`ProductVariant`[]\>
an array of variants
#### Defined in
[services/product.ts:279](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L279)
[packages/medusa/src/services/product.ts:274](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L274)
___
@@ -541,20 +648,25 @@ ___
▸ **retrieve_**(`selector`, `config?`): `Promise`<`Product`\>
Gets a product by selector.
Throws in case of DB Error and if product was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`Product`\> | |
| `config` | `FindProductConfig` | |
| `selector` | `Selector`<`Product`\> | selector object |
| `config` | `FindProductConfig` | object that defines what should be included in the query response |
#### Returns
`Promise`<`Product`\>
the result of the find one operation.
#### Defined in
[services/product.ts:242](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L242)
[packages/medusa/src/services/product.ts:238](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L238)
___
@@ -578,7 +690,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -586,20 +698,26 @@ ___
▸ **update**(`productId`, `update`): `Promise`<`Product`\>
Updates a product. Product variant updates should use dedicated methods,
e.g. `addVariant`, etc. The function will throw errors if metadata or
product variant updates are attempted.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `update` | `UpdateProductInput` | |
| `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. |
#### Returns
`Promise`<`Product`\>
resolves to the update result.
#### Defined in
[services/product.ts:399](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L399)
[packages/medusa/src/services/product.ts:445](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L445)
___
@@ -607,21 +725,26 @@ ___
▸ **updateOption**(`productId`, `optionId`, `data`): `Promise`<`Product`\>
Updates a product's option. Throws if the call tries to update an option
not associated with the product. Throws if the updated title already exists.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `optionId` | `string` | |
| `data` | `ProductOptionInput` | |
| `productId` | `string` | the product whose option we are updating |
| `optionId` | `string` | the id of the option we are updating |
| `data` | `ProductOptionInput` | the data to update the option with |
#### Returns
`Promise`<`Product`\>
the updated product
#### Defined in
[services/product.ts:637](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L637)
[packages/medusa/src/services/product.ts:722](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L722)
___
@@ -645,4 +768,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

41
docs/content/references/services/classes/ProductTypeService.md
View File

@@ -1,5 +1,7 @@
# Class: ProductTypeService
Provides layer to manipulate products.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/product-type.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L16)
[packages/medusa/src/services/product-type.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L16)
## Properties
@@ -34,7 +36,7 @@ BaseService.constructor
#### Defined in
[services/product-type.ts:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L14)
[packages/medusa/src/services/product-type.ts:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L14)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
[services/product-type.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L15)
[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L15)
## Methods
@@ -52,20 +54,24 @@ ___
▸ **list**(`selector?`, `config?`): `Promise`<`ProductType`[]\>
Lists product types
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductTypeProps` | |
| `config` | `FindConfig`<`ProductType`\> | |
| `selector` | `FilterableProductTypeProps` | the query object for find |
| `config` | `FindConfig`<`ProductType`\> | the config to be used for find |
#### Returns
`Promise`<`ProductType`[]\>
the result of the find operation
#### Defined in
[services/product-type.ts:72](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L72)
[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L72)
___
@@ -73,20 +79,24 @@ ___
▸ **listAndCount**(`selector?`, `config?`): `Promise`<[`ProductType`[], `number`]\>
Lists product tags and adds count.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductTypeProps` | |
| `config` | `FindConfig`<`ProductType`\> | |
| `selector` | `FilterableProductTypeProps` | the query object for find |
| `config` | `FindConfig`<`ProductType`\> | the config to be used for find |
#### Returns
`Promise`<[`ProductType`[], `number`]\>
the result of the find operation
#### Defined in
[services/product-type.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L88)
[packages/medusa/src/services/product-type.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L88)
___
@@ -94,20 +104,25 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`ProductType`\>
Gets a product by id.
Throws in case of DB Error and if product was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`ProductType`\> | |
| `id` | `string` | id of the product to get. |
| `config` | `FindConfig`<`ProductType`\> | object that defines what should be included in the query response |
#### Returns
`Promise`<`ProductType`\>
the result of the find one operation.
#### Defined in
[services/product-type.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L47)
[packages/medusa/src/services/product-type.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L47)
___
@@ -127,4 +142,4 @@ ___
#### Defined in
[services/product-type.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L23)
[packages/medusa/src/services/product-type.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L23)

212
docs/content/references/services/classes/ProductVariantService.md
View File

@@ -1,5 +1,7 @@
# Class: ProductVariantService
Provides layer to manipulate product variants.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L52)
[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L52)
## Properties
@@ -34,7 +36,7 @@ BaseService.constructor
#### Defined in
[services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L50)
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L50)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
[services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L45)
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L45)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
[services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L42)
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L42)
___
@@ -64,7 +66,7 @@ ___
#### Defined in
[services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L48)
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L48)
___
@@ -74,7 +76,7 @@ ___
#### Defined in
[services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L47)
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L47)
___
@@ -84,7 +86,7 @@ ___
#### Defined in
[services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L49)
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L49)
___
@@ -94,7 +96,7 @@ ___
#### Defined in
[services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L44)
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L44)
___
@@ -104,7 +106,7 @@ ___
#### Defined in
[services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L43)
[packages/medusa/src/services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L43)
___
@@ -114,7 +116,7 @@ ___
#### Defined in
[services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L46)
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L46)
___
@@ -132,7 +134,7 @@ ___
#### Defined in
[services/product-variant.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L36)
[packages/medusa/src/services/product-variant.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L36)
## Methods
@@ -140,21 +142,29 @@ ___
▸ **addOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<`ProductOptionValue`\>
Adds option value to a varaint.
Fails when product with variant does not exists or
if that product does not have an option with the given
option id. Fails if given variant is not found.
Option value must be of type string or number.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `optionId` | `string` | |
| `optionValue` | `string` | |
| `variantId` | `string` | the variant to decorate. |
| `optionId` | `string` | the option from product. |
| `optionValue` | `string` | option value to add. |
#### Returns
`Promise`<`ProductOptionValue`\>
the result of the update operation.
#### Defined in
[services/product-variant.ts:529](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L529)
[packages/medusa/src/services/product-variant.ts:529](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L529)
___
@@ -162,20 +172,25 @@ ___
▸ **create**(`productOrProductId`, `variant`): `Promise`<`ProductVariant`\>
Creates an unpublished product variant. Will validate against parent product
to ensure that the variant can in fact be created.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productOrProductId` | `string` \| `Product` | |
| `variant` | `CreateProductVariantInput` | |
| `productOrProductId` | `string` \| `Product` | the product the variant will be added to |
| `variant` | `CreateProductVariantInput` | the variant to create |
#### Returns
`Promise`<`ProductVariant`\>
resolves to the creation result.
#### Defined in
[services/product-variant.ts:183](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L183)
[packages/medusa/src/services/product-variant.ts:183](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L183)
___
@@ -183,19 +198,24 @@ ___
▸ **delete**(`variantId`): `Promise`<`void`\>
Deletes variant.
Will never fail due to delete being idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `variantId` | `string` | the id of the variant to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[services/product-variant.ts:682](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L682)
[packages/medusa/src/services/product-variant.ts:682](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L682)
___
@@ -203,20 +223,25 @@ ___
▸ **deleteOptionValue**(`variantId`, `optionId`): `Promise`<`void`\>
Deletes option value from given variant.
Will never fail due to delete being idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `optionId` | `string` | |
| `variantId` | `string` | the variant to decorate. |
| `optionId` | `string` | the option from product. |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[services/product-variant.ts:556](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L556)
[packages/medusa/src/services/product-variant.ts:556](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L556)
___
@@ -224,21 +249,27 @@ ___
▸ **getFreeTextQueryBuilder_**(`variantRepo`, `query`, `q?`): `SelectQueryBuilder`<`ProductVariant`\>
Lists variants based on the provided parameters and includes the count of
variants that match the query.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantRepo` | `ProductVariantRepository` | |
| `query` | `FindWithRelationsOptions` | |
| `q?` | `string` | |
| `variantRepo` | `ProductVariantRepository` | the variant repository |
| `query` | `FindWithRelationsOptions` | object that defines the scope for what should be returned |
| `q?` | `string` | free text query |
#### Returns
`SelectQueryBuilder`<`ProductVariant`\>
an array containing the products as the first element and the total
count of products that matches the query as the second element.
#### Defined in
[services/product-variant.ts:788](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L788)
[packages/medusa/src/services/product-variant.ts:788](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L788)
___
@@ -246,20 +277,26 @@ ___
▸ **getRegionPrice**(`variantId`, `context`): `Promise`<`number`\>
Gets the price specific to a region. If no region specific money amount
exists the function will try to use a currency price. If no default
currency price exists the function will throw an error.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `context` | `GetRegionPriceContext` | |
| `variantId` | `string` | the id of the variant to get price from |
| `context` | `GetRegionPriceContext` | context for getting region price |
#### Returns
`Promise`<`number`\>
the price specific to the region
#### Defined in
[services/product-variant.ts:404](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L404)
[packages/medusa/src/services/product-variant.ts:404](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L404)
___
@@ -271,16 +308,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductVariantProps` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `selector` | `FilterableProductVariantProps` | the query object for find |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval |
#### Returns
`Promise`<`ProductVariant`[]\>
the result of the find operation
#### Defined in
[services/product-variant.ts:624](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L624)
[packages/medusa/src/services/product-variant.ts:624](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L624)
___
@@ -292,16 +331,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductVariantProps` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `selector` | `FilterableProductVariantProps` | the query object for find |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval |
#### Returns
`Promise`<[`ProductVariant`[], `number`]\>
the result of the find operation
#### Defined in
[services/product-variant.ts:583](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L583)
[packages/medusa/src/services/product-variant.ts:583](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L583)
___
@@ -309,17 +350,22 @@ ___
▸ **prepareListQuery_**(`selector`, `config`): `Object`
Creates a query object to be used for list queries.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductVariantProps` | |
| `config` | `FindConfig`<`ProductVariant`\> | |
| `selector` | `FilterableProductVariantProps` | the selector to create the query from |
| `config` | `FindConfig`<`ProductVariant`\> | the config to use for the query |
#### Returns
`Object`
an object containing the query, relations and free-text
search param.
| Name | Type |
| :------ | :------ |
| `q?` | `string` |
@@ -328,7 +374,7 @@ ___
#### Defined in
[services/product-variant.ts:749](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L749)
[packages/medusa/src/services/product-variant.ts:749](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L749)
___
@@ -336,20 +382,24 @@ ___
▸ **retrieve**(`variantId`, `config?`): `Promise`<`ProductVariant`\>
Gets a product variant by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `variantId` | `string` | the id of the product to get. |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval. |
#### Returns
`Promise`<`ProductVariant`\>
the product document.
#### Defined in
[services/product-variant.ts:117](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L117)
[packages/medusa/src/services/product-variant.ts:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L117)
___
@@ -357,20 +407,24 @@ ___
▸ **retrieveBySKU**(`sku`, `config?`): `Promise`<`ProductVariant`\>
Gets a product variant by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `sku` | `string` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `sku` | `string` | The unique stock keeping unit used to identify the product variant. |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval. |
#### Returns
`Promise`<`ProductVariant`\>
the product document.
#### Defined in
[services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L147)
[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L147)
___
@@ -378,20 +432,24 @@ ___
▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\>
Sets the default price for the given currency.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `price` | `ProductVariantPrice` | |
| `variantId` | `string` | the id of the variant to set prices for |
| `price` | `ProductVariantPrice` | the price for the variant |
#### Returns
`Promise`<`MoneyAmount`\>
the result of the update operation
#### Defined in
[services/product-variant.ts:470](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L470)
[packages/medusa/src/services/product-variant.ts:470](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L470)
___
@@ -399,20 +457,24 @@ ___
▸ **setMetadata_**(`variant`, `metadata`): `Record`<`string`, `unknown`\>
Dedicated method to set metadata for a variant.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variant` | `ProductVariant` | |
| `metadata` | `object` | |
| `variant` | `ProductVariant` | the variant to set metadata for. |
| `metadata` | `object` | the metadata to set |
#### Returns
`Record`<`string`, `unknown`\>
updated metadata object
#### Defined in
[services/product-variant.ts:717](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L717)
[packages/medusa/src/services/product-variant.ts:717](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L717)
___
@@ -420,20 +482,24 @@ ___
▸ **setRegionPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\>
Sets the default price of a specific region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `price` | `ProductVariantPrice` | |
| `variantId` | `string` | the id of the variant to update |
| `price` | `ProductVariantPrice` | the price for the variant. |
#### Returns
`Promise`<`MoneyAmount`\>
the result of the update operation
#### Defined in
[services/product-variant.ts:433](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L433)
[packages/medusa/src/services/product-variant.ts:433](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L433)
___
@@ -441,20 +507,26 @@ ___
▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\>
Updates a variant.
Price updates should use dedicated methods.
The function will throw, if price updates are attempted.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantOrVariantId` | `string` \| `Partial`<`ProductVariant`\> | |
| `update` | `UpdateProductVariantInput` | |
| `variantOrVariantId` | `string` \| `Partial`<`ProductVariant`\> | variant or id of a variant. |
| `update` | `UpdateProductVariantInput` | an object with the update values. |
#### Returns
`Promise`<`ProductVariant`\>
resolves to the update result.
#### Defined in
[services/product-variant.ts:288](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L288)
[packages/medusa/src/services/product-variant.ts:288](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L288)
___
@@ -462,21 +534,26 @@ ___
▸ **updateOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<`ProductOptionValue`\>
Updates variant's option value.
Option value must be of type string or number.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `optionId` | `string` | |
| `optionValue` | `string` | |
| `variantId` | `string` | the variant to decorate. |
| `optionId` | `string` | the option from product. |
| `optionValue` | `string` | option value to add. |
#### Returns
`Promise`<`ProductOptionValue`\>
the result of the update operation.
#### Defined in
[services/product-variant.ts:491](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L491)
[packages/medusa/src/services/product-variant.ts:491](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L491)
___
@@ -484,20 +561,25 @@ ___
▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\>
Updates a variant's prices.
Deletes any prices that are not in the update object, and is not associated with a price list.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `prices` | `ProductVariantPrice`[] | |
| `variantId` | `string` | the id of variant variant |
| `prices` | `ProductVariantPrice`[] | the update prices |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[services/product-variant.ts:366](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L366)
[packages/medusa/src/services/product-variant.ts:366](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L366)
___
@@ -517,4 +599,4 @@ ___
#### Defined in
[services/product-variant.ts:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L89)
[packages/medusa/src/services/product-variant.ts:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L89)

6
docs/content/references/services/classes/QueryBuilderService.md
View File

@@ -34,7 +34,7 @@ BaseService.constructor
#### Defined in
[services/query-builder.js:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/query-builder.js#L25)
[packages/medusa/src/services/query-builder.js:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/query-builder.js#L25)
___
@@ -55,7 +55,7 @@ ___
#### Defined in
[services/query-builder.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/query-builder.js#L5)
[packages/medusa/src/services/query-builder.js:5](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/query-builder.js#L5)
___
@@ -76,4 +76,4 @@ ___
#### Defined in
[services/query-builder.js:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/query-builder.js#L39)
[packages/medusa/src/services/query-builder.js:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/query-builder.js#L39)

150
docs/content/references/services/classes/RegionService.md
View File

@@ -1,5 +1,7 @@
# Class: RegionService
Provides layer to manipulate regions.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/region.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L16)
[packages/medusa/src/services/region.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L16)
## Properties
@@ -42,7 +44,7 @@ BaseService.constructor
#### Defined in
[services/region.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L10)
[packages/medusa/src/services/region.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L10)
## Methods
@@ -50,20 +52,24 @@ BaseService.constructor
▸ **addCountry**(`regionId`, `code`): `Promise`<`any`\>
Adds a country to the region.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `code` | `string` | |
| `regionId` | `string` | the region to add a country to |
| `code` | `string` | a 2 digit alphanumeric ISO country code. |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:462](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L462)
[packages/medusa/src/services/region.js:462](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L462)
___
@@ -71,20 +77,25 @@ ___
▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Adds a fulfillment provider that is available in the region. Fails if the
provider doesn't exist.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to add the provider to |
| `providerId` | `string` | the provider to add to the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:582](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L582)
[packages/medusa/src/services/region.js:582](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L582)
___
@@ -92,20 +103,25 @@ ___
▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Adds a payment provider that is available in the region. Fails if the
provider doesn't exist.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to add the provider to |
| `providerId` | `string` | the provider to add to the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:535](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L535)
[packages/medusa/src/services/region.js:535](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L535)
___
@@ -113,19 +129,23 @@ ___
▸ **create**(`regionObject`): `Region`
Creates a region.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionObject` | `Region` | |
| `regionObject` | `Region` | the unvalidated region |
#### Returns
`Region`
the newly created region
#### Defined in
[services/region.js:95](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L95)
[packages/medusa/src/services/region.js:95](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L95)
___
@@ -133,19 +153,23 @@ ___
▸ **delete**(`regionId`): `Promise`<`any`\>
Deletes a region.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `regionId` | `string` | the region to delete |
#### Returns
`Promise`<`any`\>
the result of the delete operation
#### Defined in
[services/region.js:432](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L432)
[packages/medusa/src/services/region.js:432](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L432)
___
@@ -153,20 +177,24 @@ ___
▸ **list**(`selector?`, `config?`): `Promise`<`any`\>
Lists all regions based on a query
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | query object for find |
| `config` | `any` | configuration settings |
#### Returns
`Promise`<`any`\>
result of the find operation
#### Defined in
[services/region.js:420](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L420)
[packages/medusa/src/services/region.js:420](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L420)
___
@@ -174,20 +202,24 @@ ___
▸ **removeCountry**(`regionId`, `code`): `Promise`<`any`\>
Removes a country from a Region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `code` | `string` | |
| `regionId` | `string` | the region to remove from |
| `code` | `string` | a 2 digit alphanumeric ISO country code to remove |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:499](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L499)
[packages/medusa/src/services/region.js:499](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L499)
___
@@ -195,20 +227,24 @@ ___
▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Removes a fulfillment provider from a region. Is idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to remove the provider from |
| `providerId` | `string` | the provider to remove from the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:660](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L660)
[packages/medusa/src/services/region.js:660](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L660)
___
@@ -216,20 +252,24 @@ ___
▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Removes a payment provider from a region. Is idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to remove the provider from |
| `providerId` | `string` | the provider to remove from the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:626](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L626)
[packages/medusa/src/services/region.js:626](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L626)
___
@@ -237,20 +277,24 @@ ___
▸ **retrieve**(`regionId`, `config?`): `Region`
Retrieves a region by its id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `config` | `any` | |
| `regionId` | `string` | the id of the region to retrieve |
| `config` | `any` | configuration settings |
#### Returns
`Region`
the region
#### Defined in
[services/region.js:396](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L396)
[packages/medusa/src/services/region.js:396](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L396)
___
@@ -271,7 +315,7 @@ ___
#### Defined in
[services/region.js:362](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L362)
[packages/medusa/src/services/region.js:362](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L362)
___
@@ -279,20 +323,24 @@ ___
▸ **update**(`regionId`, `update`): `Promise`<`any`\>
Updates a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `update` | `any` | |
| `regionId` | `string` | the region to update |
| `update` | `any` | the data to update the region with |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:153](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L153)
[packages/medusa/src/services/region.js:153](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L153)
___
@@ -300,12 +348,15 @@ ___
▸ **validateCountry_**(`code`, `regionId`): `Promise`<`any`\>
Validates a country code. Will normalize the code before checking for
existence.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `code` | `string` | |
| `regionId` | `string` | |
| `code` | `string` | a 2 digit alphanumeric ISO country code |
| `regionId` | `string` | the id of the current region to check against |
#### Returns
@@ -313,7 +364,7 @@ ___
#### Defined in
[services/region.js:323](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L323)
[packages/medusa/src/services/region.js:323](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L323)
___
@@ -321,11 +372,13 @@ ___
▸ **validateCurrency_**(`currencyCode`): `Promise`<`void`\>
Validates a currency code. Will throw if the currency code doesn't exist.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `currencyCode` | `string` | |
| `currencyCode` | `string` | an ISO currency code |
#### Returns
@@ -333,7 +386,7 @@ ___
#### Defined in
[services/region.js:302](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L302)
[packages/medusa/src/services/region.js:302](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L302)
___
@@ -341,20 +394,25 @@ ___
▸ **validateFields_**(`region`, `id?`): `any`
Validates fields for creation and updates. If the region already exisits
the id can be passed to check that country updates are allowed.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `region` | `any` | `undefined` | |
| `id` | ``null`` \| `string` | `undefined` | |
| `region` | `any` | `undefined` | the region data to validate |
| `id` | ``null`` \| `string` | `undefined` | optional id of the region to check against |
#### Returns
`any`
the validated region data
#### Defined in
[services/region.js:213](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L213)
[packages/medusa/src/services/region.js:213](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L213)
___
@@ -362,11 +420,13 @@ ___
▸ **validateTaxRate_**(`taxRate`): `void`
Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `taxRate` | `number` | |
| `taxRate` | `number` | a number representing the tax rate of the region |
#### Returns
@@ -374,7 +434,7 @@ ___
#### Defined in
[services/region.js:289](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L289)
[packages/medusa/src/services/region.js:289](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L289)
___
@@ -394,4 +454,4 @@ ___
#### Defined in
[services/region.js:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L65)
[packages/medusa/src/services/region.js:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L65)

199
docs/content/references/services/classes/ReturnReasonService.md
View File

@@ -2,7 +2,7 @@
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`<[`ReturnReasonService`](ReturnReasonService.md)\>
↳ **`ReturnReasonService`**
@@ -16,135 +16,274 @@
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `Object` |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
BaseService.constructor
TransactionBaseService&lt;ReturnReasonService\&gt;.constructor
#### Defined in
[services/return-reason.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L5)
[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L21)
## Properties
### configModule
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L18)
___
### retReasonRepo\_
• `Protected` `Readonly` **retReasonRepo\_**: typeof `ReturnReasonRepository`
#### Defined in
[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L16)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L19)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
### create
▸ **create**(`data`): `any`
▸ **create**(`data`): `Promise`<`ReturnReason`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `data` | `any` |
| `data` | `CreateReturnReason` |
#### Returns
`any`
`Promise`<`ReturnReason`\>
#### Defined in
[services/return-reason.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L30)
[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L29)
___
### delete
▸ **delete**(`returnReasonId`): `Promise`<`any`\>
▸ **delete**(`returnReasonId`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `returnReasonId` | `any` |
| `returnReasonId` | `string` |
#### Returns
`Promise`<`any`\>
`Promise`<`void`\>
#### Defined in
[services/return-reason.js:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L114)
[packages/medusa/src/services/return-reason.ts:110](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L110)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`any`\>
▸ **list**(`selector`, `config?`): `Promise`<`ReturnReason`[]\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `Selector`<`ReturnReason`\> | the query object for find |
| `config` | `FindConfig`<`ReturnReason`\> | config object |
#### Returns
`Promise`<`any`\>
`Promise`<`ReturnReason`[]\>
the result of the find operation
#### Defined in
[services/return-reason.js:82](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L82)
[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L72)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<`Order`\>
▸ **retrieve**(`id`, `config?`): `Promise`<`ReturnReason`\>
Gets an order by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `any` | |
| `id` | `string` | id of order to retrieve |
| `config` | `FindConfig`<`ReturnReason`\> | config object |
#### Returns
`Promise`<`Order`\>
`Promise`<`ReturnReason`\>
the order document
#### Defined in
[services/return-reason.js:97](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L97)
[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L91)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
### update
▸ **update**(`id`, `data`): `any`
▸ **update**(`id`, `data`): `Promise`<`ReturnReason`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `any` |
| `data` | `any` |
| `id` | `string` |
| `data` | `UpdateReturnReason` |
#### Returns
`any`
`Promise`<`ReturnReason`\>
#### Defined in
[services/return-reason.js:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L52)
[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L50)
___
### withTransaction
▸ **withTransaction**(`manager`): [`ReturnReasonService`](ReturnReasonService.md)
▸ **withTransaction**(`transactionManager?`): [`ReturnReasonService`](ReturnReasonService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `manager` | `any` |
| `transactionManager?` | `EntityManager` |
#### Returns
[`ReturnReasonService`](ReturnReasonService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[services/return-reason.js:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L15)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

113
docs/content/references/services/classes/ReturnService.md
View File

@@ -1,5 +1,7 @@
# Class: ReturnService
Handles Returns
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/return.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L9)
[packages/medusa/src/services/return.js:9](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L9)
## Properties
@@ -34,7 +36,7 @@ BaseService.constructor
#### Defined in
[services/return.js:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L49)
[packages/medusa/src/services/return.js:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L49)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
[services/return.js:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L47)
[packages/medusa/src/services/return.js:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L47)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
[services/return.js:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L39)
[packages/medusa/src/services/return.js:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L39)
## Methods
@@ -62,19 +64,23 @@ ___
▸ **cancel**(`returnId`): `Promise`<`Return`\>
Cancels a return if possible. Returns can be canceled if it has not been received.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `returnId` | `string` | |
| `returnId` | `string` | the id of the return to cancel. |
#### Returns
`Promise`<`Return`\>
the updated Return
#### Defined in
[services/return.js:134](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L134)
[packages/medusa/src/services/return.js:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L134)
___
@@ -82,19 +88,25 @@ ___
▸ **create**(`data`): `Promise`<`Return`\>
Creates a return request for an order, with given items, and a shipping
method. If no refund amount is provided the refund amount is calculated from
the return lines and the shipping cost.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `any` | |
| `data` | `any` | data to use for the return e.g. shipping_method, items or refund_amount |
#### Returns
`Promise`<`Return`\>
the created return
#### Defined in
[services/return.js:307](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L307)
[packages/medusa/src/services/return.js:307](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L307)
___
@@ -114,7 +126,7 @@ ___
#### Defined in
[services/return.js:450](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L450)
[packages/medusa/src/services/return.js:450](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L450)
___
@@ -122,23 +134,27 @@ ___
▸ **getFulfillmentItems_**(`order`, `items`, `transformer`): `Promise`<`LineItem`[]\>
Retrieves the order line items, given an array of items
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `items` | `Object` | |
| `order` | `Order` | the order to get line items from |
| `items` | `Object` | the items to get |
| `items.item_id` | `string` | - |
| `items.quantity` | `number` | - |
| `transformer` | `Function` | |
| `transformer` | `Function` | 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
`Promise`<`LineItem`[]\>
the line items generated by the transformer.
#### Defined in
[services/return.js:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L89)
[packages/medusa/src/services/return.js:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L89)
___
@@ -150,16 +166,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | the query object for find |
| `config` | `any` | the config object for find |
#### Returns
`Promise`<`any`\>
the result of the find operation
#### Defined in
[services/return.js:120](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L120)
[packages/medusa/src/services/return.js:120](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L120)
___
@@ -167,22 +185,32 @@ ___
▸ **receive**(`return_id`, `received_items`, `refund_amount`, `allow_mismatch?`): `Promise`<`any`\>
Registers a previously requested return as received. This will create a
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
is useful in sitautions where a custom refund amount is requested, but the
retuned items are not matching the requested items. Setting the
allowMismatch argument to true, will process the return, ignoring any
mismatches.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `return_id` | `string` | `undefined` | |
| `received_items` | `Item`[] | `undefined` | |
| `refund_amount` | `undefined` \| `number` | `undefined` | |
| `allow_mismatch` | `bool` | `false` | |
| `return_id` | `string` | `undefined` | the orderId to return to |
| `received_items` | `Item`[] | `undefined` | the items received after return. |
| `refund_amount` | `undefined` \| `number` | `undefined` | the amount to return |
| `allow_mismatch` | `bool` | `false` | whether to ignore return/received product mismatch |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/return.js:524](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L524)
[packages/medusa/src/services/return.js:524](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L524)
___
@@ -190,20 +218,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Return`
Retrieves a return by its id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `any` | |
| `id` | `string` | the id of the return to retrieve |
| `config` | `any` | the config object |
#### Returns
`Return`
the return
#### Defined in
[services/return.js:229](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L229)
[packages/medusa/src/services/return.js:229](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L229)
___
@@ -224,7 +256,7 @@ ___
#### Defined in
[services/return.js:248](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L248)
[packages/medusa/src/services/return.js:248](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L248)
___
@@ -245,7 +277,7 @@ ___
#### Defined in
[services/return.js:271](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L271)
[packages/medusa/src/services/return.js:271](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L271)
___
@@ -253,21 +285,28 @@ ___
▸ **validateReturnLineItem_**(`item`, `quantity`, `additional`): `LineItem`
Checks that a given quantity of a line item can be returned. Fails if the
item is undefined or if the returnable quantity of the item is lower, than
the quantity that is requested to be returned.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `item` | `any` | |
| `quantity` | `number` | |
| `additional` | `any` | |
| `item` | `any` | the line item to check has sufficient returnable quantity. |
| `quantity` | `number` | the quantity that is requested to be returned. |
| `additional` | `any` | the quantity that is requested to be returned. |
#### Returns
`LineItem`
a line item where the quantity is set to the requested
return quantity.
#### Defined in
[services/return.js:191](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L191)
[packages/medusa/src/services/return.js:191](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L191)
___
@@ -275,11 +314,19 @@ ___
▸ **validateReturnStatuses_**(`order`): `void`
Checks that an order has the statuses necessary to complete a return.
fulfillment_status cannot be not_fulfilled or returned.
payment_status must be captured.
**`Throws`**
when statuses are not sufficient for returns.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `order` | `Order` | the order to check statuses on |
#### Returns
@@ -287,7 +334,7 @@ ___
#### Defined in
[services/return.js:161](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L161)
[packages/medusa/src/services/return.js:161](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L161)
___
@@ -307,4 +354,4 @@ ___
#### Defined in
[services/return.js:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L55)
[packages/medusa/src/services/return.js:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L55)

139
docs/content/references/services/classes/SalesChannelService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService&lt;SalesChannelService\&gt;.constructor
#### Defined in
[services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L37)
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L37)
## Properties
@@ -36,6 +36,10 @@ TransactionBaseService&lt;SalesChannelService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +50,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBusService\_
@@ -54,7 +62,7 @@ ___
#### Defined in
[services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L34)
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L34)
___
@@ -68,7 +76,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L30)
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L30)
___
@@ -78,7 +86,7 @@ ___
#### Defined in
[services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L33)
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L33)
___
@@ -88,7 +96,7 @@ ___
#### Defined in
[services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L35)
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L35)
___
@@ -102,7 +110,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L31)
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L31)
___
@@ -120,14 +128,43 @@ ___
#### Defined in
[services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L24)
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L24)
## Methods
### addProducts
▸ **addProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
Add a batch of product to a sales channel
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `salesChannelId` | `string` | The id of the sales channel on which to add the products |
| `productIds` | `string`[] | The products ids to attach to the sales channel |
#### Returns
`Promise`<`SalesChannel`\>
the sales channel on which the products have been added
#### Defined in
[packages/medusa/src/services/sales-channel.ts:277](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L277)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -139,21 +176,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -161,6 +200,11 @@ ___
▸ **create**(`data`): `Promise`<`SalesChannel`\>
Creates a SalesChannel
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.
#### Parameters
| Name | Type |
@@ -171,9 +215,11 @@ ___
`Promise`<`SalesChannel`\>
the created channel
#### Defined in
[services/sales-channel.ts:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L102)
[packages/medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L134)
___
@@ -181,13 +227,17 @@ ___
▸ **createDefault**(): `Promise`<`SalesChannel`\>
Creates a default sales channel, if this does not already exist.
#### Returns
`Promise`<`SalesChannel`\>
the sales channel
#### Defined in
[services/sales-channel.ts:182](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L182)
[packages/medusa/src/services/sales-channel.ts:224](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L224)
___
@@ -195,11 +245,15 @@ ___
▸ **delete**(`salesChannelId`): `Promise`<`void`\>
Deletes a sales channel from
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.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `salesChannelId` | `string` | |
| `salesChannelId` | `string` | the id of the sales channel to delete |
#### Returns
@@ -207,28 +261,60 @@ ___
#### Defined in
[services/sales-channel.ts:154](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L154)
[packages/medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L185)
___
### listAndCount
▸ **listAndCount**(`selector?`, `config?`): `Promise`<[`SalesChannel`[], `number`]\>
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`SalesChannel`[], `number`]\>
Lists sales channels based on the provided parameters and includes the count of
sales channels that match the query.
#### Parameters
| Name | Type |
| :------ | :------ |
| `selector` | `QuerySelector`<`any`\> |
| `config` | `FindConfig`<`any`\> |
| `selector` | `QuerySelector`<`SalesChannel`\> |
| `config` | `FindConfig`<`SalesChannel`\> |
#### Returns
`Promise`<[`SalesChannel`[], `number`]\>
an array containing the sales channels as
the first element and the total count of sales channels that matches the query
as the second element.
#### Defined in
[services/sales-channel.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L88)
[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L99)
___
### removeProducts
▸ **removeProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
Remove a batch of product from a sales channel
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `salesChannelId` | `string` | The id of the sales channel on which to remove the products |
| `productIds` | `string`[] | The products ids to remove from the sales channel |
#### Returns
`Promise`<`SalesChannel`\>
the sales channel on which the products have been removed
#### Defined in
[packages/medusa/src/services/sales-channel.ts:256](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L256)
___
@@ -236,6 +322,11 @@ ___
▸ **retrieve**(`salesChannelId`, `config?`): `Promise`<`SalesChannel`\>
Retrieve a SalesChannel by id
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.
#### Parameters
| Name | Type |
@@ -247,9 +338,11 @@ ___
`Promise`<`SalesChannel`\>
a sales channel
#### Defined in
[services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L59)
[packages/medusa/src/services/sales-channel.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L64)
___
@@ -273,7 +366,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -294,7 +387,7 @@ ___
#### Defined in
[services/sales-channel.ts:119](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L119)
[packages/medusa/src/services/sales-channel.ts:151](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L151)
___
@@ -318,4 +411,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

284
docs/content/references/services/classes/SearchService.md
View File

@@ -2,7 +2,7 @@
## Hierarchy
- `"medusa-interfaces"`
- `AbstractSearchService`<[`SearchService`](SearchService.md)\>
↳ **`SearchService`**
@@ -10,41 +10,134 @@
### constructor
• **new SearchService**(`container`)
• **new SearchService**(`__namedParameters`, `options`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `container` | `any` |
| `__namedParameters` | `InjectedDependencies` |
| `options` | `any` |
#### Overrides
SearchService.constructor
AbstractSearchService&lt;DefaultSearchService\&gt;.constructor
#### Defined in
[services/search.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L8)
[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L18)
## Properties
### isDefault
### configModule
• **isDefault**: `boolean`
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
AbstractSearchService.configModule
#### Defined in
[services/search.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L11)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
AbstractSearchService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### isDefault
• **isDefault**: `boolean` = `true`
#### Overrides
AbstractSearchService.isDefault
#### Defined in
[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L11)
___
### logger\_
• **logger\_**: `any`
• `Protected` `Readonly` **logger\_**: `Logger`
#### Defined in
[services/search.js:13](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L13)
[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L15)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
AbstractSearchService.manager\_
#### Defined in
[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L13)
___
### options\_
• `Protected` `Readonly` **options\_**: `Record`<`string`, `unknown`\>
#### Overrides
AbstractSearchService.options\_
#### Defined in
[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L16)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
AbstractSearchService.transactionManager\_
#### Defined in
[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L14)
## Accessors
### options
• `get` **options**(): `Record`<`string`, `unknown`\>
#### Returns
`Record`<`string`, `unknown`\>
#### Inherited from
AbstractSearchService.options
#### Defined in
[packages/medusa/src/interfaces/search-service.ts:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/search-service.ts#L84)
## Methods
@@ -56,17 +149,60 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `documents` | `any` |
| `type` | `any` |
| `indexName` | `string` |
| `documents` | `unknown` |
| `type` | `string` |
#### Returns
`void`
#### Overrides
AbstractSearchService.addDocuments
#### Defined in
[services/search.js:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L28)
[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L43)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
AbstractSearchService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -78,16 +214,20 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `options` | `any` |
| `indexName` | `string` |
| `options` | `unknown` |
#### Returns
`void`
#### Overrides
AbstractSearchService.createIndex
#### Defined in
[services/search.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L16)
[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L31)
___
@@ -99,15 +239,19 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `indexName` | `string` |
#### Returns
`void`
#### Overrides
AbstractSearchService.deleteAllDocuments
#### Defined in
[services/search.js:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L46)
[packages/medusa/src/services/search.ts:61](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L61)
___
@@ -119,16 +263,20 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `document_id` | `any` |
| `indexName` | `string` |
| `document_id` | `string` \| `number` |
#### Returns
`void`
#### Overrides
AbstractSearchService.deleteDocument
#### Defined in
[services/search.js:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L40)
[packages/medusa/src/services/search.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L55)
___
@@ -140,15 +288,19 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `indexName` | `string` |
#### Returns
`void`
#### Overrides
AbstractSearchService.getIndex
#### Defined in
[services/search.js:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L22)
[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L37)
___
@@ -160,17 +312,21 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `documents` | `any` |
| `type` | `any` |
| `indexName` | `string` |
| `documents` | `unknown` |
| `type` | `string` |
#### Returns
`void`
#### Overrides
AbstractSearchService.replaceDocuments
#### Defined in
[services/search.js:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L34)
[packages/medusa/src/services/search.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L49)
___
@@ -182,9 +338,9 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `query` | `any` |
| `options` | `any` |
| `indexName` | `string` |
| `query` | `unknown` |
| `options` | `unknown` |
#### Returns
@@ -192,11 +348,39 @@ ___
| Name | Type |
| :------ | :------ |
| `hits` | `never`[] |
| `hits` | `unknown`[] |
#### Overrides
AbstractSearchService.search
#### Defined in
[services/search.js:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L52)
[packages/medusa/src/services/search.ts:67](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L67)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
AbstractSearchService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -208,13 +392,41 @@ ___
| Name | Type |
| :------ | :------ |
| `indexName` | `any` |
| `settings` | `any` |
| `indexName` | `string` |
| `settings` | `unknown` |
#### Returns
`void`
#### Overrides
AbstractSearchService.updateSettings
#### Defined in
[services/search.js:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L59)
[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L78)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`SearchService`](SearchService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`SearchService`](SearchService.md)
#### Inherited from
AbstractSearchService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

201
docs/content/references/services/classes/ShippingOptionService.md
View File

@@ -1,5 +1,7 @@
# Class: ShippingOptionService
Provides layer to manipulate profiles.
## Hierarchy
- `TransactionBaseService`<[`ShippingOptionService`](ShippingOptionService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;ShippingOptionService\&gt;.constructor
#### Defined in
[services/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L39)
[packages/medusa/src/services/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L39)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;ShippingOptionService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### manager\_
@@ -58,7 +68,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/shipping-option.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L36)
[packages/medusa/src/services/shipping-option.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L36)
___
@@ -68,7 +78,7 @@ ___
#### Defined in
[services/shipping-option.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L34)
[packages/medusa/src/services/shipping-option.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L34)
___
@@ -78,7 +88,7 @@ ___
#### Defined in
[services/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L33)
[packages/medusa/src/services/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L33)
___
@@ -88,7 +98,7 @@ ___
#### Defined in
[services/shipping-option.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L30)
[packages/medusa/src/services/shipping-option.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L30)
___
@@ -98,7 +108,7 @@ ___
#### Defined in
[services/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L31)
[packages/medusa/src/services/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L31)
___
@@ -108,7 +118,7 @@ ___
#### Defined in
[services/shipping-option.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L32)
[packages/medusa/src/services/shipping-option.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L32)
___
@@ -122,7 +132,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L37)
[packages/medusa/src/services/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L37)
## Methods
@@ -130,20 +140,25 @@ TransactionBaseService.transactionManager\_
▸ **addRequirement**(`optionId`, `requirement`): `Promise`<`ShippingOption`\>
Adds a requirement to a shipping option. Only 1 requirement of each type
is allowed.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | |
| `requirement` | `ShippingOptionRequirement` | |
| `optionId` | `string` | the option to add the requirement to. |
| `requirement` | `ShippingOptionRequirement` | the requirement for the option. |
#### Returns
`Promise`<`ShippingOption`\>
the result of update
#### Defined in
[services/shipping-option.ts:627](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L627)
[packages/medusa/src/services/shipping-option.ts:623](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L623)
___
@@ -151,6 +166,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -162,21 +181,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -184,19 +205,25 @@ ___
▸ **create**(`data`): `Promise`<`ShippingOption`\>
Creates a new shipping option. Used both for outbound and inbound shipping
options. The difference is registered by the `is_return` field which
defaults to false.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateShippingOptionInput` | |
| `data` | `CreateShippingOptionInput` | the data to create shipping options |
#### Returns
`Promise`<`ShippingOption`\>
the result of the create operation
#### Defined in
[services/shipping-option.ts:384](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L384)
[packages/medusa/src/services/shipping-option.ts:380](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L380)
___
@@ -204,21 +231,25 @@ ___
▸ **createShippingMethod**(`optionId`, `data`, `config`): `Promise`<`ShippingMethod`\>
Creates a shipping method for a given cart.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | |
| `data` | `object` | |
| `config` | `CreateShippingMethodDto` | |
| `optionId` | `string` | the id of the option to use for the method. |
| `data` | `object` | the optional provider data to use. |
| `config` | `CreateShippingMethodDto` | the cart to create the shipping method for. |
#### Returns
`Promise`<`ShippingMethod`\>
the resulting shipping method.
#### Defined in
[services/shipping-option.ts:259](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L259)
[packages/medusa/src/services/shipping-option.ts:253](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L253)
___
@@ -226,19 +257,23 @@ ___
▸ **delete**(`optionId`): `Promise`<`void` \| `ShippingOption`\>
Deletes a profile with a given profile id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | |
| `optionId` | `string` | the id of the profile to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`void` \| `ShippingOption`\>
the result of the delete operation.
#### Defined in
[services/shipping-option.ts:605](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L605)
[packages/medusa/src/services/shipping-option.ts:601](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L601)
___
@@ -246,19 +281,23 @@ ___
▸ **deleteShippingMethods**(`shippingMethods`): `Promise`<`ShippingMethod`[]\>
Removes a given shipping method
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `shippingMethods` | `ShippingMethod` \| `ShippingMethod`[] | |
| `shippingMethods` | `ShippingMethod` \| `ShippingMethod`[] | the shipping method to remove |
#### Returns
`Promise`<`ShippingMethod`[]\>
removed shipping methods
#### Defined in
[services/shipping-option.ts:239](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L239)
[packages/medusa/src/services/shipping-option.ts:233](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L233)
___
@@ -266,21 +305,27 @@ ___
▸ **getPrice_**(`option`, `data`, `cart`): `Promise`<`number`\>
Returns the amount to be paid for a shipping method. Will ask the
fulfillment provider to calculate the price if the shipping option has the
price type "calculated".
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `option` | `ShippingOption` | |
| `data` | `object` | |
| `cart` | `undefined` \| `Order` \| `Cart` | |
| `option` | `ShippingOption` | the shipping option to retrieve the price for. |
| `data` | `object` | the shipping data to retrieve the price. |
| `cart` | `undefined` \| `Order` \| `Cart` | the context in which the price should be retrieved. |
#### Returns
`Promise`<`number`\>
the price of the shipping option.
#### Defined in
[services/shipping-option.ts:686](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L686)
[packages/medusa/src/services/shipping-option.ts:682](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L682)
___
@@ -292,16 +337,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`ShippingMethod`\> | |
| `config` | `FindConfig`<`ShippingOption`\> | |
| `selector` | `Selector`<`ShippingMethod`\> | the query object for find |
| `config` | `FindConfig`<`ShippingOption`\> | config object |
#### Returns
`Promise`<`ShippingOption`[]\>
the result of the find operation
#### Defined in
[services/shipping-option.ts:130](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L130)
[packages/medusa/src/services/shipping-option.ts:130](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L130)
___
@@ -313,16 +360,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `Selector`<`ShippingMethod`\> | |
| `config` | `FindConfig`<`ShippingOption`\> | |
| `selector` | `Selector`<`ShippingMethod`\> | the query object for find |
| `config` | `FindConfig`<`ShippingOption`\> | config object |
#### Returns
`Promise`<[`ShippingOption`[], `number`]\>
the result of the find operation
#### Defined in
[services/shipping-option.ts:149](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L149)
[packages/medusa/src/services/shipping-option.ts:146](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L146)
___
@@ -330,19 +379,23 @@ ___
▸ **removeRequirement**(`requirementId`): `Promise`<`void` \| `ShippingOptionRequirement`\>
Removes a requirement from a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `requirementId` | `any` | |
| `requirementId` | `any` | the id of the requirement to remove |
#### Returns
`Promise`<`void` \| `ShippingOptionRequirement`\>
the result of update
#### Defined in
[services/shipping-option.ts:656](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L656)
[packages/medusa/src/services/shipping-option.ts:652](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L652)
___
@@ -350,12 +403,15 @@ ___
▸ **retrieve**(`optionId`, `options?`): `Promise`<`ShippingOption`\>
Gets a profile by id.
Throws in case of DB Error and if profile was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `any` | |
| `options` | `Object` | |
| `optionId` | `any` | the id of the profile to get. |
| `options` | `Object` | the options to get a profile |
| `options.relations?` | `string`[] | - |
| `options.select?` | keyof `ShippingOption`[] | - |
@@ -363,9 +419,11 @@ ___
`Promise`<`ShippingOption`\>
the profile document.
#### Defined in
[services/shipping-option.ts:170](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L170)
[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L164)
___
@@ -389,7 +447,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -397,20 +455,26 @@ ___
▸ **update**(`optionId`, `update`): `Promise`<`ShippingOption`\>
Updates a profile. Metadata updates and product updates should use
dedicated methods, e.g. `setMetadata`, etc. The function
will throw errors if metadata or product updates are attempted.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | |
| `update` | `UpdateShippingOptionInput` | |
| `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. |
#### Returns
`Promise`<`ShippingOption`\>
resolves to the update result.
#### Defined in
[services/shipping-option.ts:498](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L498)
[packages/medusa/src/services/shipping-option.ts:494](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L494)
___
@@ -418,41 +482,52 @@ ___
▸ **updateShippingMethod**(`id`, `update`): `Promise`<`undefined` \| `ShippingMethod`\>
Updates a shipping method's associations. Useful when a cart is completed
and its methods should be copied to an order/swap entity.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `update` | `ShippingMethodUpdate` | |
| `id` | `string` | the id of the shipping method to update |
| `update` | `ShippingMethodUpdate` | the values to update the method with |
#### Returns
`Promise`<`undefined` \| `ShippingMethod`\>
the resulting shipping method
#### Defined in
[services/shipping-option.ts:210](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L210)
[packages/medusa/src/services/shipping-option.ts:204](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L204)
___
### validateCartOption
▸ **validateCartOption**(`option`, `cart`): ``null`` \| `ShippingOption`
▸ **validateCartOption**(`option`, `cart`): `Promise`<``null`` \| `ShippingOption`\>
Checks if a given option id is a valid option for a cart. If it is the
option is returned with the correct price. Throws when region_ids do not
match, or when the shipping option requirements are not satisfied.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `option` | `ShippingOption` | |
| `cart` | `Cart` | |
| `option` | `ShippingOption` | the option object to check |
| `cart` | `Cart` | the cart object to check against |
#### Returns
``null`` \| `ShippingOption`
`Promise`<``null`` \| `ShippingOption`\>
the validated shipping option
#### Defined in
[services/shipping-option.ts:337](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L337)
[packages/medusa/src/services/shipping-option.ts:331](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L331)
___
@@ -460,20 +535,24 @@ ___
▸ **validatePriceType_**(`priceType`, `option`): `Promise`<`ShippingOptionPriceType`\>
Validates a shipping option price
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `priceType` | `ShippingOptionPriceType` | |
| `option` | `ShippingOption` | |
| `priceType` | `ShippingOptionPriceType` | the price to validate |
| `option` | `ShippingOption` | the option to validate against |
#### Returns
`Promise`<`ShippingOptionPriceType`\>
the validated price
#### Defined in
[services/shipping-option.ts:462](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L462)
[packages/medusa/src/services/shipping-option.ts:458](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L458)
___
@@ -481,20 +560,24 @@ ___
▸ **validateRequirement_**(`requirement`, `optionId?`): `Promise`<`ShippingOptionRequirement`\>
Validates a requirement
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `requirement` | `ShippingOptionRequirement` | `undefined` | |
| `optionId` | `undefined` \| `string` | `undefined` | |
| `requirement` | `ShippingOptionRequirement` | `undefined` | the requirement to validate |
| `optionId` | `undefined` \| `string` | `undefined` | the id to validate the requirement |
#### Returns
`Promise`<`ShippingOptionRequirement`\>
a validated shipping requirement
#### Defined in
[services/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L64)
[packages/medusa/src/services/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L64)
___
@@ -518,4 +601,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

129
docs/content/references/services/classes/ShippingProfileService.md
View File

@@ -1,5 +1,9 @@
# Class: ShippingProfileService
Provides layer to manipulate profiles.
**`Implements`**
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +28,7 @@ BaseService.constructor
#### Defined in
[services/shipping-profile.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L12)
[packages/medusa/src/services/shipping-profile.js:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L12)
## Methods
@@ -32,20 +36,25 @@ BaseService.constructor
▸ **addProduct**(`profileId`, `productId`): `Promise`<`any`\>
Adds a product to a profile. The method is idempotent, so multiple calls
with the same product variant will have the same result.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `profileId` | `string` | |
| `productId` | `string` | |
| `profileId` | `string` | the profile to add the product to. |
| `productId` | `string` | the product to add. |
#### Returns
`Promise`<`any`\>
the result of update
#### Defined in
[services/shipping-profile.js:343](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L343)
[packages/medusa/src/services/shipping-profile.js:343](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L343)
___
@@ -53,20 +62,25 @@ ___
▸ **addShippingOption**(`profileId`, `optionId`): `Promise`<`any`\>
Adds a shipping option to the profile. The shipping option can be used to
fulfill the products in the products field.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `profileId` | `string` | |
| `optionId` | `string` | |
| `profileId` | `string` | the profile to apply the shipping option to |
| `optionId` | `string` | the option to add to the profile |
#### Returns
`Promise`<`any`\>
the result of the model update operation
#### Defined in
[services/shipping-profile.js:361](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L361)
[packages/medusa/src/services/shipping-profile.js:361](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L361)
___
@@ -74,19 +88,23 @@ ___
▸ **create**(`profile`): `Promise`<`any`\>
Creates a new shipping profile.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `profile` | `ShippingProfile` | |
| `profile` | `ShippingProfile` | the shipping profile to create from |
#### Returns
`Promise`<`any`\>
the result of the create operation
#### Defined in
[services/shipping-profile.js:235](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L235)
[packages/medusa/src/services/shipping-profile.js:235](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L235)
___
@@ -94,13 +112,17 @@ ___
▸ **createDefault**(): `Promise`<`ShippingProfile`\>
Creates a default shipping profile, if this does not already exist.
#### Returns
`Promise`<`ShippingProfile`\>
the shipping profile
#### Defined in
[services/shipping-profile.js:167](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L167)
[packages/medusa/src/services/shipping-profile.js:167](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L167)
___
@@ -108,13 +130,18 @@ ___
▸ **createGiftCardDefault**(): `Promise`<`ShippingProfile`\>
Creates a default shipping profile, for gift cards if unless it already
exists.
#### Returns
`Promise`<`ShippingProfile`\>
the shipping profile
#### Defined in
[services/shipping-profile.js:209](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L209)
[packages/medusa/src/services/shipping-profile.js:209](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L209)
___
@@ -122,21 +149,25 @@ ___
▸ **decorate**(`profile`, `fields`, `expandFields?`): `Profile`
Decorates a profile.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `profile` | `Profile` | `undefined` | |
| `fields` | `string`[] | `undefined` | |
| `expandFields` | `string`[] | `[]` | |
| `profile` | `Profile` | `undefined` | the profile to decorate. |
| `fields` | `string`[] | `undefined` | the fields to include. |
| `expandFields` | `string`[] | `[]` | fields to expand. |
#### Returns
`Profile`
return the decorated profile.
#### Defined in
[services/shipping-profile.js:379](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L379)
[packages/medusa/src/services/shipping-profile.js:379](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L379)
___
@@ -144,19 +175,23 @@ ___
▸ **delete**(`profileId`): `Promise`<`any`\>
Deletes a profile with a given profile id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `profileId` | `string` | |
| `profileId` | `string` | the id of the profile to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`any`\>
the result of the delete operation.
#### Defined in
[services/shipping-profile.js:317](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L317)
[packages/medusa/src/services/shipping-profile.js:317](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L317)
___
@@ -164,19 +199,24 @@ ___
▸ **fetchCartOptions**(`cart`): `Promise`<[`ShippingOption`]\>
Finds all the shipping profiles that cover the products in a cart, and
validates all options that are available for the cart.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart` | `Cart` | |
| `cart` | `Cart` | the cart object to find shipping options for |
#### Returns
`Promise`<[`ShippingOption`]\>
a list of the available shipping options
#### Defined in
[services/shipping-profile.js:425](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L425)
[packages/medusa/src/services/shipping-profile.js:425](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L425)
___
@@ -197,7 +237,7 @@ ___
#### Defined in
[services/shipping-profile.js:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L73)
[packages/medusa/src/services/shipping-profile.js:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L73)
___
@@ -205,19 +245,23 @@ ___
▸ **getProfilesInCart_**(`cart`): [`string`]
Returns a list of all the productIds in the cart.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart` | `Cart` | |
| `cart` | `Cart` | the cart to extract products from |
#### Returns
[`string`]
a list of product ids
#### Defined in
[services/shipping-profile.js:406](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L406)
[packages/medusa/src/services/shipping-profile.js:406](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L406)
___
@@ -229,16 +273,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | the query object for find |
| `config` | `any` | the config object for find |
#### Returns
`Promise`<`any`\>
the result of the find operation
#### Defined in
[services/shipping-profile.js:64](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L64)
[packages/medusa/src/services/shipping-profile.js:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L64)
___
@@ -246,20 +292,25 @@ ___
▸ **retrieve**(`profileId`, `options?`): `Promise`<`Product`\>
Gets a profile by id.
Throws in case of DB Error and if profile was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `profileId` | `string` | |
| `options` | `any` | |
| `profileId` | `string` | the id of the profile to get. |
| `options` | `any` | options opf the query. |
#### Returns
`Promise`<`Product`\>
the profile document.
#### Defined in
[services/shipping-profile.js:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L121)
[packages/medusa/src/services/shipping-profile.js:121](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L121)
___
@@ -273,7 +324,7 @@ ___
#### Defined in
[services/shipping-profile.js:151](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L151)
[packages/medusa/src/services/shipping-profile.js:151](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L151)
___
@@ -281,13 +332,17 @@ ___
▸ **retrieveGiftCardDefault**(): `any`
Retrieves the default gift card profile
#### Returns
`any`
the shipping profile for gift cards
#### Defined in
[services/shipping-profile.js:192](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L192)
[packages/medusa/src/services/shipping-profile.js:192](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L192)
___
@@ -295,20 +350,26 @@ ___
▸ **update**(`profileId`, `update`): `Promise`<`any`\>
Updates a profile. Metadata updates and product updates should use
dedicated methods, e.g. `setMetadata`, `addProduct`, etc. The function
will throw errors if metadata or product updates are attempted.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `profileId` | `string` | |
| `update` | `any` | |
| `profileId` | `string` | the id of the profile. Must be a string that can be casted to an ObjectId |
| `update` | `any` | an object with the update values. |
#### Returns
`Promise`<`any`\>
resolves to the update result.
#### Defined in
[services/shipping-profile.js:263](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L263)
[packages/medusa/src/services/shipping-profile.js:263](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L263)
___
@@ -328,4 +389,4 @@ ___
#### Defined in
[services/shipping-profile.js:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L41)
[packages/medusa/src/services/shipping-profile.js:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L41)

80
docs/content/references/services/classes/StoreService.md
View File

@@ -1,5 +1,7 @@
# Class: StoreService
Provides layer to manipulate store settings.
## Hierarchy
- `TransactionBaseService`<[`StoreService`](StoreService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;StoreService\&gt;.constructor
#### Defined in
[services/store.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L33)
[packages/medusa/src/services/store.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L32)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;StoreService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### currencyRepository\_
@@ -54,7 +64,7 @@ ___
#### Defined in
[services/store.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L30)
[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L29)
___
@@ -64,7 +74,7 @@ ___
#### Defined in
[services/store.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L31)
[packages/medusa/src/services/store.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L30)
___
@@ -78,7 +88,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/store.ts:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L26)
[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L25)
___
@@ -88,7 +98,7 @@ ___
#### Defined in
[services/store.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L29)
[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L28)
___
@@ -102,7 +112,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/store.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L27)
[packages/medusa/src/services/store.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L26)
## Methods
@@ -110,19 +120,23 @@ TransactionBaseService.transactionManager\_
▸ **addCurrency**(`code`): `Promise`<`Store`\>
Add a currency to the store
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `code` | `string` | |
| `code` | `string` | 3 character ISO currency code |
#### Returns
`Promise`<`Store`\>
result after update
#### Defined in
[services/store.ts:219](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L219)
[packages/medusa/src/services/store.ts:210](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L210)
___
@@ -130,6 +144,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -141,21 +159,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -163,13 +183,17 @@ ___
▸ **create**(): `Promise`<`Store`\>
Creates a store if it doesn't already exist.
#### Returns
`Promise`<`Store`\>
The store.
#### Defined in
[services/store.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L56)
[packages/medusa/src/services/store.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L55)
___
@@ -189,7 +213,7 @@ ___
#### Defined in
[services/store.ts:113](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L113)
[packages/medusa/src/services/store.ts:104](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L104)
___
@@ -197,19 +221,23 @@ ___
▸ **removeCurrency**(`code`): `Promise`<`any`\>
Removes a currency from the store
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `code` | `string` | |
| `code` | `string` | 3 character ISO currency code |
#### Returns
`Promise`<`any`\>
result after update
#### Defined in
[services/store.ts:263](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L263)
[packages/medusa/src/services/store.ts:254](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L254)
___
@@ -217,19 +245,23 @@ ___
▸ **retrieve**(`config?`): `Promise`<`Store`\>
Retrieve the store settings. There is always a maximum of one store.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | `FindConfig`<`Store`\> | |
| `config` | `FindConfig`<`Store`\> | The config object from which the query will be built |
#### Returns
`Promise`<`Store`\>
the store
#### Defined in
[services/store.ts:92](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L92)
[packages/medusa/src/services/store.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L91)
___
@@ -253,7 +285,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -261,19 +293,23 @@ ___
▸ **update**(`data`): `Promise`<`Store`\>
Updates a store
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `UpdateStoreInput` | |
| `data` | `UpdateStoreInput` | an object with the update values. |
#### Returns
`Promise`<`Store`\>
resolves to the update result.
#### Defined in
[services/store.ts:129](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L129)
[packages/medusa/src/services/store.ts:120](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L120)
___
@@ -297,4 +333,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

34
docs/content/references/services/classes/StrategyResolverService.md
View File

@@ -27,7 +27,7 @@ TransactionBaseService&lt;
#### Defined in
[services/strategy-resolver.ts:17](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L17)
[packages/medusa/src/services/strategy-resolver.ts:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L17)
## Properties
@@ -39,6 +39,10 @@ TransactionBaseService&lt;
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -49,6 +53,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### manager\_
@@ -61,7 +69,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L14)
[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L14)
___
@@ -75,7 +83,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/strategy-resolver.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L15)
[packages/medusa/src/services/strategy-resolver.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L15)
## Methods
@@ -83,6 +91,10 @@ TransactionBaseService.transactionManager\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -94,21 +106,23 @@ TransactionBaseService.transactionManager\_
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -134,7 +148,7 @@ ___
#### Defined in
[services/strategy-resolver.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L22)
[packages/medusa/src/services/strategy-resolver.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L22)
___
@@ -158,7 +172,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -182,4 +196,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

151
docs/content/references/services/classes/SwapService.md
View File

@@ -1,5 +1,7 @@
# Class: SwapService
Handles swaps
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/swap.js:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L21)
[packages/medusa/src/services/swap.js:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L21)
## Properties
@@ -48,7 +50,7 @@ BaseService.constructor
#### Defined in
[services/swap.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L9)
[packages/medusa/src/services/swap.js:9](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L9)
## Methods
@@ -56,19 +58,25 @@ BaseService.constructor
▸ **cancel**(`swapId`): `Promise`<`Swap`\>
Cancels a given swap if possible. A swap can only be canceled if all
related returns, fulfillments, and payments have been canceled. If a swap
is associated with a refund, it cannot be canceled.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `swapId` | `string` | |
| `swapId` | `string` | the id of the swap to cancel. |
#### Returns
`Promise`<`Swap`\>
the canceled swap.
#### Defined in
[services/swap.js:790](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L790)
[packages/medusa/src/services/swap.js:792](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L792)
___
@@ -76,19 +84,23 @@ ___
▸ **cancelFulfillment**(`fulfillmentId`): `Swap`
Cancels a fulfillment (if related to a swap)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `fulfillmentId` | `string` | |
| `fulfillmentId` | `string` | the ID of the fulfillment to cancel |
#### Returns
`Swap`
updated swap
#### Defined in
[services/swap.js:983](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L983)
[packages/medusa/src/services/swap.js:985](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L985)
___
@@ -96,23 +108,28 @@ ___
▸ **create**(`order`, `returnItems`, `additionalItems`, `returnShipping`, `custom?`): `Promise`<`Swap`\>
Creates a swap from an order, with given return items, additional items
and an optional return shipping method.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `returnItems` | `ReturnItem`[] | |
| `additionalItems` | `undefined` \| `PreliminaryLineItem`[] | |
| `returnShipping` | `any` | |
| `custom` | `any` | |
| `order` | `Order` | the order to base the swap off. |
| `returnItems` | `ReturnItem`[] | the items to return in the swap. |
| `additionalItems` | `undefined` \| `PreliminaryLineItem`[] | the items to send to the customer. |
| `returnShipping` | `any` | an optional shipping method for returning the returnItems. |
| `custom` | `any` | 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. |
#### Returns
`Promise`<`Swap`\>
the newly created swap.
#### Defined in
[services/swap.js:313](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L313)
[packages/medusa/src/services/swap.js:315](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L315)
___
@@ -120,20 +137,28 @@ ___
▸ **createCart**(`swapId`, `customShippingOptions?`): `Promise`<`Swap`\>
Creates a cart from the given swap and order. The cart can be used to pay
for differences associated with the swap. The swap represented by the
swapId must belong to the order. Fails if there is already a cart on the
swap.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `swapId` | `string` | `undefined` | |
| `customShippingOptions` | `any`[] | `[]` | |
| `swapId` | `string` | `undefined` | the id of the swap to create the cart from |
| `customShippingOptions` | `any`[] | `[]` | the shipping options |
#### Returns
`Promise`<`Swap`\>
the swap with its cart_id prop set to the id of
the new cart.
#### Defined in
[services/swap.js:544](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L544)
[packages/medusa/src/services/swap.js:546](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L546)
___
@@ -141,20 +166,25 @@ ___
▸ **createFulfillment**(`swapId`, `config?`): `Promise`<`Swap`\>
Fulfills the addtional items associated with the swap. Will call the
fulfillment providers associated with the shipping methods.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `swapId` | `string` | |
| `config` | `any` | |
| `swapId` | `string` | the id of the swap to fulfill, |
| `config` | `any` | optional configurations, includes optional metadata to attach to the shipment, and a no_notification flag. |
#### Returns
`Promise`<`Swap`\>
the updated swap with new status and fulfillments.
#### Defined in
[services/swap.js:848](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L848)
[packages/medusa/src/services/swap.js:850](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L850)
___
@@ -162,22 +192,26 @@ ___
▸ **createShipment**(`swapId`, `fulfillmentId`, `trackingLinks`, `config?`): `Promise`<`Swap`\>
Marks a fulfillment as shipped and attaches tracking numbers.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `swapId` | `string` | |
| `fulfillmentId` | `string` | |
| `trackingLinks` | `undefined` \| `TrackingLink`[] | |
| `config` | `any` | |
| `swapId` | `string` | the id of the swap that has been shipped. |
| `fulfillmentId` | `string` | the id of the specific fulfillment that has been shipped |
| `trackingLinks` | `undefined` \| `TrackingLink`[] | the tracking numbers associated with the shipment |
| `config` | `any` | optional configurations, includes optional metadata to attach to the shipment, and a noNotification flag. |
#### Returns
`Promise`<`Swap`\>
the updated swap with new fulfillments and status.
#### Defined in
[services/swap.js:1016](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L1016)
[packages/medusa/src/services/swap.js:1018](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L1018)
___
@@ -185,20 +219,24 @@ ___
▸ **deleteMetadata**(`swapId`, `key`): `Promise`<`any`\>
Dedicated method to delete metadata for a swap.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `swapId` | `string` | |
| `key` | `string` | |
| `swapId` | `string` | the order to delete metadata from. |
| `key` | `string` | key for metadata field |
#### Returns
`Promise`<`any`\>
resolves to the updated result.
#### Defined in
[services/swap.js:1089](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L1089)
[packages/medusa/src/services/swap.js:1091](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L1091)
___
@@ -210,16 +248,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | the query object for find |
| `config` | `any` | the configuration used to find the objects. contains relations, skip, and take. |
#### Returns
`Promise`<`any`\>
the result of the find operation
#### Defined in
[services/swap.js:238](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L238)
[packages/medusa/src/services/swap.js:240](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L240)
___
@@ -239,7 +279,7 @@ ___
#### Defined in
[services/swap.js:395](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L395)
[packages/medusa/src/services/swap.js:397](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L397)
___
@@ -251,7 +291,7 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `swapId` | `string` | |
| `swapId` | `string` | The id of the swap |
#### Returns
@@ -259,7 +299,7 @@ ___
#### Defined in
[services/swap.js:659](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L659)
[packages/medusa/src/services/swap.js:661](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L661)
___
@@ -267,19 +307,24 @@ ___
▸ **registerReceived**(`id`): `Promise`<`Order`\>
Registers the swap return items as received so that they cannot be used
as a part of other swaps/returns.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `id` | `string` | the id of the order with the swap. |
#### Returns
`Promise`<`Order`\>
the resulting order
#### Defined in
[services/swap.js:1114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L1114)
[packages/medusa/src/services/swap.js:1116](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L1116)
___
@@ -287,20 +332,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`Swap`\>
Retrieves a swap with the given id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `any` | |
| `id` | `string` | the id of the swap to retrieve |
| `config` | `any` | the configuration to retrieve the swap |
#### Returns
`Promise`<`Swap`\>
the swap
#### Defined in
[services/swap.js:181](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L181)
[packages/medusa/src/services/swap.js:181](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L181)
___
@@ -308,20 +357,24 @@ ___
▸ **retrieveByCartId**(`cartId`, `relations?`): `Promise`<`Swap`\>
Retrieves a swap based on its associated cart id
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `cartId` | `string` | `undefined` | |
| `relations` | `string`[] | `[]` | |
| `cartId` | `string` | `undefined` | the cart id that the swap's cart has |
| `relations` | `string`[] | `[]` | the relations to retrieve swap |
#### Returns
`Promise`<`Swap`\>
the swap
#### Defined in
[services/swap.js:216](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L216)
[packages/medusa/src/services/swap.js:218](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L218)
___
@@ -341,7 +394,7 @@ ___
#### Defined in
[services/swap.js:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L114)
[packages/medusa/src/services/swap.js:114](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L114)
___
@@ -362,7 +415,7 @@ ___
#### Defined in
[services/swap.js:511](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L511)
[packages/medusa/src/services/swap.js:513](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L513)
___
@@ -370,20 +423,26 @@ ___
▸ **validateReturnItems_**(`order`, `returnItems`): `ReturnItems`[]
Goes through a list of return items to ensure that they exist on the
original order. If the item exists it is verified that the quantity to
return is not higher than the original quantity ordered.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `OrderLike` | |
| `returnItems` | `ReturnItem`[] | |
| `order` | `OrderLike` | the order to return from |
| `returnItems` | `ReturnItem`[] | the items to return |
#### Returns
`ReturnItems`[]
the validated returnItems
#### Defined in
[services/swap.js:269](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L269)
[packages/medusa/src/services/swap.js:271](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L271)
___
@@ -403,4 +462,4 @@ ___
#### Defined in
[services/swap.js:86](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L86)
[packages/medusa/src/services/swap.js:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L86)

24
docs/content/references/services/classes/SystemPaymentProviderService.md
View File

@@ -24,7 +24,7 @@ BaseService.constructor
#### Defined in
[services/system-payment-provider.js:6](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L6)
[packages/medusa/src/services/system-payment-provider.js:6](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L6)
## Properties
@@ -34,7 +34,7 @@ BaseService.constructor
#### Defined in
[services/system-payment-provider.js:4](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L4)
[packages/medusa/src/services/system-payment-provider.js:4](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L4)
## Methods
@@ -54,7 +54,7 @@ BaseService.constructor
#### Defined in
[services/system-payment-provider.js:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L22)
[packages/medusa/src/services/system-payment-provider.js:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L22)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[services/system-payment-provider.js:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L46)
[packages/medusa/src/services/system-payment-provider.js:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L46)
___
@@ -94,7 +94,7 @@ ___
#### Defined in
[services/system-payment-provider.js:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L38)
[packages/medusa/src/services/system-payment-provider.js:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L38)
___
@@ -114,7 +114,7 @@ ___
#### Defined in
[services/system-payment-provider.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L10)
[packages/medusa/src/services/system-payment-provider.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L10)
___
@@ -134,7 +134,7 @@ ___
#### Defined in
[services/system-payment-provider.js:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L34)
[packages/medusa/src/services/system-payment-provider.js:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L34)
___
@@ -154,7 +154,7 @@ ___
#### Defined in
[services/system-payment-provider.js:18](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L18)
[packages/medusa/src/services/system-payment-provider.js:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L18)
___
@@ -174,7 +174,7 @@ ___
#### Defined in
[services/system-payment-provider.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L14)
[packages/medusa/src/services/system-payment-provider.js:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L14)
___
@@ -194,7 +194,7 @@ ___
#### Defined in
[services/system-payment-provider.js:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L42)
[packages/medusa/src/services/system-payment-provider.js:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L42)
___
@@ -214,7 +214,7 @@ ___
#### Defined in
[services/system-payment-provider.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L30)
[packages/medusa/src/services/system-payment-provider.js:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L30)
___
@@ -234,4 +234,4 @@ ___
#### Defined in
[services/system-payment-provider.js:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L26)
[packages/medusa/src/services/system-payment-provider.js:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L26)

278
docs/content/references/services/classes/TaxProviderService.md
View File

@@ -1,8 +1,10 @@
# Class: TaxProviderService
Finds tax providers and assists in tax related operations.
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`<[`TaxProviderService`](TaxProviderService.md)\>
↳ **`TaxProviderService`**
@@ -20,94 +22,179 @@
#### Overrides
BaseService.constructor
TransactionBaseService&lt;TaxProviderService\&gt;.constructor
#### Defined in
[services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L49)
[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L53)
## Properties
### container\_
### configModule
• `Private` **container\_**: `AwilixContainer`<`any`\>
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
#### Defined in
[services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L40)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### container\_
• `Protected` `Readonly` **container\_**: `AwilixContainer`<`any`\>
#### Defined in
[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L45)
___
### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L51)
___
### manager\_
• `Private` **manager\_**: `EntityManager`
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L41)
[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L42)
___
### redis\_
• `Private` **redis\_**: `Redis`
• `Protected` `Readonly` **redis\_**: `Redis`
#### Defined in
[services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L47)
[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L50)
___
### smTaxLineRepo\_
• `Private` **smTaxLineRepo\_**: typeof `ShippingMethodTaxLineRepository`
• `Protected` `Readonly` **smTaxLineRepo\_**: typeof `ShippingMethodTaxLineRepository`
#### Defined in
[services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L45)
[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L48)
___
### taxLineRepo\_
• `Private` **taxLineRepo\_**: typeof `LineItemTaxLineRepository`
• `Protected` `Readonly` **taxLineRepo\_**: typeof `LineItemTaxLineRepository`
#### Defined in
[services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L44)
[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L47)
___
### taxProviderRepo\_
• `Private` **taxProviderRepo\_**: typeof `TaxProviderRepository`
• `Protected` `Readonly` **taxProviderRepo\_**: typeof `TaxProviderRepository`
#### Defined in
[services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L46)
[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L49)
___
### taxRateService\_
• `Private` **taxRateService\_**: [`TaxRateService`](TaxRateService.md)
• `Protected` `Readonly` **taxRateService\_**: [`TaxRateService`](TaxRateService.md)
#### Defined in
[services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L43)
[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L46)
___
### transactionManager\_
• `Private` **transactionManager\_**: `EntityManager`
• `Protected` **transactionManager\_**: `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L42)
[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L43)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
### clearTaxLines
▸ **clearTaxLines**(`cartId`): `Promise`<`void`\>
@@ -124,7 +211,7 @@ ___
#### Defined in
[services/tax-provider.ts:103](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L103)
[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L94)
___
@@ -132,20 +219,25 @@ ___
▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
Persists the tax lines relevant for a shipping method to the database. Used
for return shipping methods.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `shippingMethod` | `ShippingMethod` | |
| `calculationContext` | `TaxCalculationContext` | |
| `shippingMethod` | `ShippingMethod` | the shipping method to create tax lines for |
| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |
#### Returns
`Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
the newly created tax lines
#### Defined in
[services/tax-provider.ts:171](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L171)
[packages/medusa/src/services/tax-provider.ts:170](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L170)
___
@@ -153,20 +245,24 @@ ___
▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
Persists the tax lines relevant for an order to the database.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrLineItems` | `Cart` \| `LineItem`[] | |
| `calculationContext` | `TaxCalculationContext` | |
| `cartOrLineItems` | `Cart` \| `LineItem`[] | the cart or line items to create tax lines for |
| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |
#### Returns
`Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
the newly created tax lines
#### Defined in
[services/tax-provider.ts:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L121)
[packages/medusa/src/services/tax-provider.ts:116](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L116)
___
@@ -174,20 +270,24 @@ ___
▸ `Private` **getCacheEntry**(`productId`, `regionId`): `Promise`<``null`` \| `TaxServiceRate`[]\>
Gets the cache results for a set of ids
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `regionId` | `string` | |
| `productId` | `string` | the product id to cache |
| `regionId` | `string` | the region id to cache |
#### Returns
`Promise`<``null`` \| `TaxServiceRate`[]\>
the cached result or null
#### Defined in
[services/tax-provider.ts:454](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L454)
[packages/medusa/src/services/tax-provider.ts:457](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L457)
___
@@ -195,20 +295,24 @@ ___
▸ `Private` **getCacheKey**(`productId`, `regionId`): `string`
The cache key to get cache hits by.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `regionId` | `string` | |
| `productId` | `string` | the product id to cache |
| `regionId` | `string` | the region id to cache |
#### Returns
`string`
the cache key to use for the id set
#### Defined in
[services/tax-provider.ts:423](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L423)
[packages/medusa/src/services/tax-provider.ts:426](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L426)
___
@@ -216,20 +320,25 @@ ___
▸ **getRegionRatesForProduct**(`productId`, `region`): `Promise`<`TaxServiceRate`[]\>
Gets the tax rates configured for a product. The rates are cached between
calls.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `region` | `RegionDetails` | |
| `productId` | `string` | the product id to get rates for |
| `region` | `RegionDetails` | the region to get configured rates for. |
#### Returns
`Promise`<`TaxServiceRate`[]\>
the tax rates configured for the shipping option.
#### Defined in
[services/tax-provider.ts:378](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L378)
[packages/medusa/src/services/tax-provider.ts:379](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L379)
___
@@ -237,20 +346,25 @@ ___
▸ **getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<`TaxServiceRate`[]\>
Gets the tax rates configured for a shipping option. The rates are cached
between calls.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `optionId` | `string` | |
| `regionDetails` | `RegionDetails` | |
| `optionId` | `string` | the option id of the shipping method. |
| `regionDetails` | `RegionDetails` | the region to get configured rates for. |
#### Returns
`Promise`<`TaxServiceRate`[]\>
the tax rates configured for the shipping option.
#### Defined in
[services/tax-provider.ts:332](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L332)
[packages/medusa/src/services/tax-provider.ts:333](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L333)
___
@@ -258,20 +372,26 @@ ___
▸ **getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<`ShippingMethodTaxLine`[]\>
Gets the relevant tax lines for a shipping method. Note: this method
doesn't persist the tax lines. Use createShippingTaxLines if you wish to
persist the tax lines to the DB layer.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `shippingMethod` | `ShippingMethod` | |
| `calculationContext` | `TaxCalculationContext` | |
| `shippingMethod` | `ShippingMethod` | the shipping method to get tax lines for |
| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |
#### Returns
`Promise`<`ShippingMethodTaxLine`[]\>
the computed tax lines
#### Defined in
[services/tax-provider.ts:190](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L190)
[packages/medusa/src/services/tax-provider.ts:191](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L191)
___
@@ -279,20 +399,28 @@ ___
▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
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
will be computed from the tax rules and potentially a 3rd party tax plugin.
Note: this method doesn't persist the tax lines. Use createTaxLines if you
wish to persist the tax lines to the DB layer.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `lineItems` | `LineItem`[] | |
| `calculationContext` | `TaxCalculationContext` | |
| `lineItems` | `LineItem`[] | the cart or order to get tax lines for |
| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by |
#### Returns
`Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\>
the computed tax lines
#### Defined in
[services/tax-provider.ts:242](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L242)
[packages/medusa/src/services/tax-provider.ts:243](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L243)
___
@@ -306,7 +434,7 @@ ___
#### Defined in
[services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L75)
[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L66)
___
@@ -326,7 +454,7 @@ ___
#### Defined in
[services/tax-provider.ts:475](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L475)
[packages/medusa/src/services/tax-provider.ts:478](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L478)
___
@@ -334,19 +462,23 @@ ___
▸ **retrieveProvider**(`region`): `ITaxService`
Retrieves the relevant tax provider for the given region.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `region` | `Region` | |
| `region` | `Region` | the region to get tax provider for. |
#### Returns
`ITaxService`
the region specific tax provider
#### Defined in
[services/tax-provider.ts:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L85)
[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L76)
___
@@ -354,38 +486,70 @@ ___
▸ `Private` **setCache**(`productId`, `regionId`, `value`): `Promise`<`void`\>
Sets the cache results for a set of ids
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productId` | `string` | |
| `regionId` | `string` | |
| `value` | `TaxServiceRate`[] | |
| `productId` | `string` | the product id to cache |
| `regionId` | `string` | the region id to cache |
| `value` | `TaxServiceRate`[] | tax rates to cache |
#### Returns
`Promise`<`void`\>
promise that resolves after the cache has been set
#### Defined in
[services/tax-provider.ts:434](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L434)
[packages/medusa/src/services/tax-provider.ts:437](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L437)
___
### withTransaction
### shouldRetryTransaction\_
▸ **withTransaction**(`transactionManager`): [`TaxProviderService`](TaxProviderService.md)
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager` | `EntityManager` |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`TaxProviderService`](TaxProviderService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`TaxProviderService`](TaxProviderService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[services/tax-provider.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L62)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

42
docs/content/references/services/classes/TaxRateService.md
View File

@@ -24,7 +24,7 @@ BaseService.constructor
#### Defined in
[services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L27)
[packages/medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L27)
## Properties
@@ -34,7 +34,7 @@ BaseService.constructor
#### Defined in
[services/tax-rate.ts:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L21)
[packages/medusa/src/services/tax-rate.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L21)
___
@@ -44,7 +44,7 @@ ___
#### Defined in
[services/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L22)
[packages/medusa/src/services/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L22)
___
@@ -54,7 +54,7 @@ ___
#### Defined in
[services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L23)
[packages/medusa/src/services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L23)
___
@@ -64,7 +64,7 @@ ___
#### Defined in
[services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L24)
[packages/medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L24)
___
@@ -74,7 +74,7 @@ ___
#### Defined in
[services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L25)
[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L25)
## Methods
@@ -96,7 +96,7 @@ ___
#### Defined in
[services/tax-rate.ts:197](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L197)
[packages/medusa/src/services/tax-rate.ts:196](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L196)
___
@@ -118,7 +118,7 @@ ___
#### Defined in
[services/tax-rate.ts:233](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L233)
[packages/medusa/src/services/tax-rate.ts:232](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L232)
___
@@ -140,7 +140,7 @@ ___
#### Defined in
[services/tax-rate.ts:273](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L273)
[packages/medusa/src/services/tax-rate.ts:272](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L272)
___
@@ -160,7 +160,7 @@ ___
#### Defined in
[services/tax-rate.ts:104](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L104)
[packages/medusa/src/services/tax-rate.ts:103](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L103)
___
@@ -180,7 +180,7 @@ ___
#### Defined in
[services/tax-rate.ts:135](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L135)
[packages/medusa/src/services/tax-rate.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L134)
___
@@ -201,7 +201,7 @@ ___
#### Defined in
[services/tax-rate.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L62)
[packages/medusa/src/services/tax-rate.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L62)
___
@@ -222,7 +222,7 @@ ___
#### Defined in
[services/tax-rate.ts:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L73)
[packages/medusa/src/services/tax-rate.ts:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L73)
___
@@ -243,7 +243,7 @@ ___
#### Defined in
[services/tax-rate.ts:321](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L321)
[packages/medusa/src/services/tax-rate.ts:320](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L320)
___
@@ -263,7 +263,7 @@ ___
#### Defined in
[services/tax-rate.ts:332](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L332)
[packages/medusa/src/services/tax-rate.ts:330](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L330)
___
@@ -284,7 +284,7 @@ ___
#### Defined in
[services/tax-rate.ts:143](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L143)
[packages/medusa/src/services/tax-rate.ts:142](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L142)
___
@@ -305,7 +305,7 @@ ___
#### Defined in
[services/tax-rate.ts:161](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L161)
[packages/medusa/src/services/tax-rate.ts:160](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L160)
___
@@ -326,7 +326,7 @@ ___
#### Defined in
[services/tax-rate.ts:179](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L179)
[packages/medusa/src/services/tax-rate.ts:178](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L178)
___
@@ -347,7 +347,7 @@ ___
#### Defined in
[services/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L84)
[packages/medusa/src/services/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L84)
___
@@ -368,7 +368,7 @@ ___
#### Defined in
[services/tax-rate.ts:120](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L120)
[packages/medusa/src/services/tax-rate.ts:119](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L119)
___
@@ -388,4 +388,4 @@ ___
#### Defined in
[services/tax-rate.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L43)
[packages/medusa/src/services/tax-rate.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L43)

388
docs/content/references/services/classes/TotalsService.md
View File

@@ -1,8 +1,12 @@
# Class: TotalsService
A service that calculates total and subtotals for orders, carts etc..
**`Implements`**
## Hierarchy
- `"medusa-interfaces"`
- `TransactionBaseService`<[`TotalsService`](TotalsService.md)\>
↳ **`TotalsService`**
@@ -20,21 +24,63 @@
#### Overrides
BaseService.constructor
TransactionBaseService&lt;TotalsService\&gt;.constructor
#### Defined in
[services/totals.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L90)
[packages/medusa/src/services/totals.ts:99](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L99)
## Properties
### configModule
• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
• `Protected` `Readonly` **container**: `unknown`
#### Inherited from
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Overrides
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/totals.ts:93](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L93)
___
### taxCalculationStrategy\_
• `Private` **taxCalculationStrategy\_**: `ITaxCalculationStrategy`
#### Defined in
[services/totals.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L88)
[packages/medusa/src/services/totals.ts:97](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L97)
___
@@ -44,31 +90,88 @@ ___
#### Defined in
[services/totals.ts:87](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L87)
[packages/medusa/src/services/totals.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L96)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `EntityManager`
#### Overrides
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/totals.ts:94](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L94)
## Methods
### calculateDiscount\_
### atomicPhase\_
▸ **calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): `LineDiscount`
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `lineItem` | `LineItem` | |
| `variant` | `string` | |
| `variantPrice` | `number` | |
| `value` | `number` | |
| `discountType` | `DiscountRuleType` | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
### calculateDiscount\_
▸ **calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): `LineDiscount`
Calculates either fixed or percentage discount of a variant
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `lineItem` | `LineItem` | id of line item |
| `variant` | `string` | id of variant in line item |
| `variantPrice` | `number` | price of the variant based on region |
| `value` | `number` | discount value |
| `discountType` | `DiscountRuleType` | the type of discount (fixed or percentage) |
#### Returns
`LineDiscount`
triples of lineitem, variant and applied discount
#### Defined in
[services/totals.ts:553](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L553)
[packages/medusa/src/services/totals.ts:567](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L567)
___
@@ -76,20 +179,28 @@ ___
▸ **getAllocationItemDiscounts**(`discount`, `cart`): `LineDiscount`[]
If the rule of a discount has allocation="item", then we need
to calculate discount on each item in the cart. Furthermore, we need to
make sure to only apply the discount on valid variants. And finally we
return ether an array of percentages discounts or fixed discounts
alongside the variant on which the discount was applied.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discount` | `Discount` | |
| `cart` | `Order` \| `Cart` | |
| `discount` | `Discount` | the discount to which we do the calculation |
| `cart` | `Order` \| `Cart` | the cart to calculate discounts for |
#### Returns
`LineDiscount`[]
array of triples of lineitem, variant and applied discount
#### Defined in
[services/totals.ts:595](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L595)
[packages/medusa/src/services/totals.ts:609](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L609)
___
@@ -97,20 +208,26 @@ ___
▸ **getAllocationMap**(`orderOrCart`, `options?`): `LineAllocationsMap`
Gets a map of discounts and gift cards that apply to line items in an
order. The function calculates the amount of a discount or gift card that
applies to a specific line item.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `orderOrCart` | `Order` \| `Cart` | |
| `options` | `AllocationMapOptions` | |
| `orderOrCart` | `Order` \| `Cart` | the order or cart to get an allocation map for |
| `options` | `AllocationMapOptions` | controls what should be included in allocation map |
#### Returns
`LineAllocationsMap`
the allocation map for the line items in the cart or order.
#### Defined in
[services/totals.ts:376](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L376)
[packages/medusa/src/services/totals.ts:390](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L390)
___
@@ -118,20 +235,24 @@ ___
▸ **getCalculationContext**(`cartOrOrder`, `options?`): `TaxCalculationContext`
Prepares the calculation context for a tax total calculation.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `options` | `CalculationContextOptions` | |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get the calculation context for |
| `options` | `CalculationContextOptions` | options to gather context by |
#### Returns
`TaxCalculationContext`
the tax calculation context
#### Defined in
[services/totals.ts:959](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L959)
[packages/medusa/src/services/totals.ts:972](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L972)
___
@@ -139,19 +260,24 @@ ___
▸ **getDiscountTotal**(`cartOrOrder`): `number`
Calculates the total discount amount for each of the different supported
discount types. If discounts aren't present or invalid returns 0.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to calculate discounts for |
#### Returns
`number`
the total discounts amount
#### Defined in
[services/totals.ts:925](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L925)
[packages/medusa/src/services/totals.ts:938](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L938)
___
@@ -159,16 +285,20 @@ ___
▸ **getGiftCardTotal**(`cartOrOrder`): `Object`
Gets the gift card amount on a cart or order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get gift card amount for |
#### Returns
`Object`
the gift card amount applied to the cart or order
| Name | Type |
| :------ | :------ |
| `tax_total` | `number` |
@@ -176,7 +306,7 @@ ___
#### Defined in
[services/totals.ts:853](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L853)
[packages/medusa/src/services/totals.ts:866](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L866)
___
@@ -184,19 +314,24 @@ ___
▸ **getGiftCardableAmount**(`cartOrOrder`): `Promise`<`number`\>
Gets the amount that can be gift carded on a cart. In regions where gift
cards are taxable this amount should exclude taxes.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get gift card amount for |
#### Returns
`Promise`<`number`\>
the gift card amount applied to the cart or order
#### Defined in
[services/totals.ts:838](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L838)
[packages/medusa/src/services/totals.ts:851](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L851)
___
@@ -204,20 +339,25 @@ ___
▸ **getLineDiscounts**(`cartOrOrder`, `discount`): `LineDiscountAmount`[]
Returns the discount amount allocated to the line items of an order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `discount` | `Discount` | |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get line discount allocations for |
| `discount` | `Discount` | the discount to use as context for the calculation |
#### Returns
`LineDiscountAmount`[]
the allocations that the discount has on the items in the cart or
order
#### Defined in
[services/totals.ts:646](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L646)
[packages/medusa/src/services/totals.ts:660](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L660)
___
@@ -237,7 +377,7 @@ ___
#### Defined in
[services/totals.ts:623](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L623)
[packages/medusa/src/services/totals.ts:637](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L637)
___
@@ -258,7 +398,7 @@ ___
#### Defined in
[services/totals.ts:608](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L608)
[packages/medusa/src/services/totals.ts:622](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L622)
___
@@ -266,20 +406,24 @@ ___
▸ **getLineItemRefund**(`order`, `lineItem`): `number`
The amount that can be refunded for a given line item.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `lineItem` | `LineItem` | |
| `order` | `Order` | order to use as context for the calculation |
| `lineItem` | `LineItem` | the line item to calculate the refund amount for. |
#### Returns
`number`
the line item refund amount.
#### Defined in
[services/totals.ts:468](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L468)
[packages/medusa/src/services/totals.ts:482](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L482)
___
@@ -287,21 +431,26 @@ ___
▸ **getLineItemTotal**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<`number`\>
Gets a total for a line item. The total can take gift cards, discounts and
taxes into account. This can be controlled through the options.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `lineItem` | `LineItem` | |
| `cartOrOrder` | `Order` \| `Cart` | |
| `options` | `GetLineItemTotalOptions` | |
| `lineItem` | `LineItem` | the line item to calculate a total for |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the calculation |
| `options` | `GetLineItemTotalOptions` | the options to use for the calculation |
#### Returns
`Promise`<`number`\>
the line item total
#### Defined in
[services/totals.ts:807](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L807)
[packages/medusa/src/services/totals.ts:820](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L820)
___
@@ -309,21 +458,27 @@ ___
▸ **getLineItemTotals**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<`LineItemTotals`\>
Breaks down the totals related to a line item; these are the subtotal, the
amount of discount applied to the line item, the amount of a gift card
applied to a line item and the amount of tax applied to a line item.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `lineItem` | `LineItem` | |
| `cartOrOrder` | `Order` \| `Cart` | |
| `options` | `LineItemTotalsOptions` | |
| `lineItem` | `LineItem` | the line item to calculate totals for |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the calculation |
| `options` | `LineItemTotalsOptions` | the options to evaluate the line item totals for |
#### Returns
`Promise`<`LineItemTotals`\>
the breakdown of the line item totals
#### Defined in
[services/totals.ts:692](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L692)
[packages/medusa/src/services/totals.ts:706](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L706)
___
@@ -331,19 +486,23 @@ ___
▸ **getPaidTotal**(`order`): `number`
Gets the total payments made on an order
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `order` | `Order` | the order to calculate paid amount for |
#### Returns
`number`
the total paid amount
#### Defined in
[services/totals.ts:129](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L129)
[packages/medusa/src/services/totals.ts:145](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L145)
___
@@ -351,20 +510,26 @@ ___
▸ **getRefundTotal**(`order`, `lineItems`): `number`
Calculates refund total of line items.
If any of the items to return have been discounted, we need to
apply the discount again before refunding them.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `lineItems` | `LineItem`[] | |
| `order` | `Order` | cart or order to calculate subtotal for |
| `lineItems` | `LineItem`[] | the line items to calculate refund total for |
#### Returns
`number`
the calculated subtotal
#### Defined in
[services/totals.ts:512](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L512)
[packages/medusa/src/services/totals.ts:526](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L526)
___
@@ -372,19 +537,23 @@ ___
▸ **getRefundedTotal**(`order`): `number`
Gets the total refund amount for an order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `order` | `Order` | the order to get total refund amount for. |
#### Returns
`number`
the total refunded amount for an order.
#### Defined in
[services/totals.ts:453](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L453)
[packages/medusa/src/services/totals.ts:467](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L467)
___
@@ -392,21 +561,26 @@ ___
▸ **getShippingMethodTotals**(`shippingMethod`, `cartOrOrder`, `opts?`): `Promise`<`ShippingMethodTotals`\>
Gets the totals breakdown for a shipping method. Fetches tax lines if not
already provided.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `shippingMethod` | `ShippingMethod` | |
| `cartOrOrder` | `Order` \| `Cart` | |
| `opts` | `GetShippingMethodTotalsOptions` | |
| `shippingMethod` | `ShippingMethod` | the shipping method to get totals breakdown for. |
| `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the breakdown |
| `opts` | `GetShippingMethodTotalsOptions` | options for what should be included |
#### Returns
`Promise`<`ShippingMethodTotals`\>
An object that breaks down the totals for the shipping method
#### Defined in
[services/totals.ts:163](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L163)
[packages/medusa/src/services/totals.ts:179](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L179)
___
@@ -414,19 +588,23 @@ ___
▸ **getShippingTotal**(`cartOrOrder`): `number`
Calculates shipping total
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `cartOrOrder` | `Order` \| `Cart` | cart or order to calculate subtotal for |
#### Returns
`number`
shipping total
#### Defined in
[services/totals.ts:271](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L271)
[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L286)
___
@@ -434,20 +612,24 @@ ___
▸ **getSubtotal**(`cartOrOrder`, `opts?`): `number`
Calculates subtotal of a given cart or order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `opts` | `SubtotalOptions` | |
| `cartOrOrder` | `Order` \| `Cart` | cart or order to calculate subtotal for |
| `opts` | `SubtotalOptions` | options |
#### Returns
`number`
the calculated subtotal
#### Defined in
[services/totals.ts:247](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L247)
[packages/medusa/src/services/totals.ts:262](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L262)
___
@@ -455,19 +637,24 @@ ___
▸ **getSwapTotal**(`order`): `number`
The total paid for swaps. May be negative in case of negative swap
difference.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `order` | `Order` | |
| `order` | `Order` | the order to calculate swap total for |
#### Returns
`number`
the swap total
#### Defined in
[services/totals.ts:144](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L144)
[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L160)
___
@@ -475,20 +662,25 @@ ___
▸ **getTaxTotal**(`cartOrOrder`, `forceTaxes?`): `Promise`<``null`` \| `number`\>
Calculates tax total
Currently based on the Danish tax system
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | `undefined` | |
| `forceTaxes` | `boolean` | `false` | |
| `cartOrOrder` | `Order` \| `Cart` | `undefined` | cart or order to calculate tax total for |
| `forceTaxes` | `boolean` | `false` | whether taxes should be calculated regardless of region settings |
#### Returns
`Promise`<``null`` \| `number`\>
tax total
#### Defined in
[services/totals.ts:286](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L286)
[packages/medusa/src/services/totals.ts:301](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L301)
___
@@ -496,20 +688,24 @@ ___
▸ **getTotal**(`cartOrOrder`, `options?`): `Promise`<`number`\>
Calculates subtotal of a given cart or order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartOrOrder` | `Order` \| `Cart` | |
| `options` | `GetTotalsOptions` | |
| `cartOrOrder` | `Order` \| `Cart` | object to calculate total for |
| `options` | `GetTotalsOptions` | options to calculate by |
#### Returns
`Promise`<`number`\>
the calculated subtotal
#### Defined in
[services/totals.ts:106](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L106)
[packages/medusa/src/services/totals.ts:122](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L122)
___
@@ -517,16 +713,68 @@ ___
▸ **rounded**(`value`): `number`
Rounds a number using Math.round.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | `number` | |
| `value` | `number` | the value to round |
#### Returns
`number`
the rounded value
#### Defined in
[services/totals.ts:989](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L989)
[packages/medusa/src/services/totals.ts:1002](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L1002)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`TotalsService`](TotalsService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`TotalsService`](TotalsService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)

153
docs/content/references/services/classes/UserService.md
View File

@@ -1,5 +1,7 @@
# Class: UserService
Provides layer to manipulate users.
## Hierarchy
- `TransactionBaseService`<[`UserService`](UserService.md)\>
@@ -24,7 +26,7 @@ TransactionBaseService&lt;UserService\&gt;.constructor
#### Defined in
[services/user.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L37)
[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L40)
## Properties
@@ -36,6 +38,10 @@ TransactionBaseService&lt;UserService\&gt;.constructor
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -46,6 +52,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### eventBus\_
@@ -54,7 +64,7 @@ ___
#### Defined in
[services/user.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L35)
[packages/medusa/src/services/user.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L38)
___
@@ -68,7 +78,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/user.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L32)
[packages/medusa/src/services/user.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L35)
___
@@ -82,7 +92,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/user.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L33)
[packages/medusa/src/services/user.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L36)
___
@@ -92,7 +102,7 @@ ___
#### Defined in
[services/user.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L34)
[packages/medusa/src/services/user.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L37)
___
@@ -104,11 +114,14 @@ ___
| Name | Type |
| :------ | :------ |
| `CREATED` | `string` |
| `DELETED` | `string` |
| `PASSWORD_RESET` | `string` |
| `UPDATED` | `string` |
#### Defined in
[services/user.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L28)
[packages/medusa/src/services/user.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L28)
## Methods
@@ -116,6 +129,10 @@ ___
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
@@ -127,21 +144,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -149,20 +168,25 @@ ___
▸ **create**(`user`, `password`): `Promise`<`User`\>
Creates a user with username being validated.
Fails if email is not a valid format.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `user` | `CreateUserInput` | |
| `password` | `string` | |
| `user` | `CreateUserInput` | the user to create |
| `password` | `string` | user's password to hash |
#### Returns
`Promise`<`User`\>
the result of create
#### Defined in
[services/user.ts:183](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L183)
[packages/medusa/src/services/user.ts:176](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L176)
___
@@ -170,19 +194,23 @@ ___
▸ **delete**(`userId`): `Promise`<`void`\>
Deletes a user from a given user id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `userId` | `string` | |
| `userId` | `string` | the id of the user to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`void`\>
the result of the delete operation.
#### Defined in
[services/user.ts:251](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L251)
[packages/medusa/src/services/user.ts:256](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L256)
___
@@ -190,19 +218,27 @@ ___
▸ **generateResetPasswordToken**(`userId`): `Promise`<`string`\>
Generate a JSON Web token, that will be sent to a user, that wishes to
reset password.
The token will be signed with the users current password hash as a secret
a long side a payload with userId and the expiry time for the token, which
is always 15 minutes.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `userId` | `string` | |
| `userId` | `string` | the id of the user to reset password for |
#### Returns
`Promise`<`string`\>
the generated JSON web token
#### Defined in
[services/user.ts:305](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L305)
[packages/medusa/src/services/user.ts:312](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L312)
___
@@ -210,19 +246,23 @@ ___
▸ **hashPassword_**(`password`): `Promise`<`string`\>
Hashes a password
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `password` | `string` | |
| `password` | `string` | the value to hash |
#### Returns
`Promise`<`string`\>
hashed password
#### Defined in
[services/user.ts:171](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L171)
[packages/medusa/src/services/user.ts:164](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L164)
___
@@ -234,16 +274,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableUserProps` | |
| `config` | `Object` | |
| `selector` | `FilterableUserProps` | the query object for find |
| `config` | `Object` | the configuration object for the query |
#### Returns
`Promise`<`User`[]\>
the result of the find operation
#### Defined in
[services/user.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L68)
[packages/medusa/src/services/user.ts:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L73)
___
@@ -251,20 +293,25 @@ ___
▸ **retrieve**(`userId`, `config?`): `Promise`<`User`\>
Gets a user by id.
Throws in case of DB Error and if user was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `userId` | `string` | |
| `config` | `FindConfig`<`User`\> | |
| `userId` | `string` | the id of the user to get. |
| `config` | `FindConfig`<`User`\> | query configs |
#### Returns
`Promise`<`User`\>
the user document.
#### Defined in
[services/user.ts:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L84)
[packages/medusa/src/services/user.ts:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L86)
___
@@ -272,20 +319,25 @@ ___
▸ **retrieveByApiToken**(`apiToken`, `relations?`): `Promise`<`User`\>
Gets a user by api token.
Throws in case of DB Error and if user was not found.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `apiToken` | `string` | `undefined` | |
| `relations` | `string`[] | `[]` | |
| `apiToken` | `string` | `undefined` | the token of the user to get. |
| `relations` | `string`[] | `[]` | relations to include with the user |
#### Returns
`Promise`<`User`\>
the user document.
#### Defined in
[services/user.ts:111](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L111)
[packages/medusa/src/services/user.ts:110](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L110)
___
@@ -293,20 +345,25 @@ ___
▸ **retrieveByEmail**(`email`, `config?`): `Promise`<`User`\>
Gets a user by email.
Throws in case of DB Error and if user was not found.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `email` | `string` | |
| `config` | `FindConfig`<`User`\> | |
| `email` | `string` | the email of the user to get. |
| `config` | `FindConfig`<`User`\> | query config |
#### Returns
`Promise`<`User`\>
the user document.
#### Defined in
[services/user.ts:143](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L143)
[packages/medusa/src/services/user.ts:139](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L139)
___
@@ -314,20 +371,26 @@ ___
▸ **setPassword_**(`userId`, `password`): `Promise`<`User`\>
Sets a password for a user
Fails if no user exists with userId and if the hashing of the new
password does not work.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `userId` | `string` | |
| `password` | `string` | |
| `userId` | `string` | the userId to set password for |
| `password` | `string` | the old password to set |
#### Returns
`Promise`<`User`\>
the result of the update operation
#### Defined in
[services/user.ts:276](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L276)
[packages/medusa/src/services/user.ts:283](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L283)
___
@@ -351,7 +414,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -359,20 +422,24 @@ ___
▸ **update**(`userId`, `update`): `Promise`<`User`\>
Updates a user.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `userId` | `string` | |
| `update` | `UpdateUserInput` | |
| `userId` | `string` | id of the user to update |
| `update` | `UpdateUserInput` | the values to be updated on the user |
#### Returns
`Promise`<`User`\>
the result of create
#### Defined in
[services/user.ts:211](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L211)
[packages/medusa/src/services/user.ts:210](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L210)
___
@@ -380,19 +447,23 @@ ___
▸ **validateEmail_**(`email`): `string`
Used to validate user email.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `email` | `string` | |
| `email` | `string` | email to validate |
#### Returns
`string`
the validated email
#### Defined in
[services/user.ts:50](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L50)
[packages/medusa/src/services/user.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L53)
___
@@ -416,4 +487,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)