chore(docs): Generated References (#5516)

Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions

View File

@@ -1,4 +1,4 @@
# Class: BatchJobService
# BatchJobService
## Hierarchy
@@ -10,12 +10,12 @@
### constructor
**new BatchJobService**(`«destructured»`)
**new BatchJobService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `«destructured»` | `InjectedDependencies` |
#### Overrides
@@ -24,13 +24,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/batch-job.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L91)
[medusa/src/services/batch-job.ts:91](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L91)
## Properties
### \_\_configModule\_\_
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -38,13 +38,13 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
`Protected` `Readonly` **\_\_container\_\_**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
@@ -52,13 +52,13 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -66,43 +66,43 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### batchJobRepository\_
`Protected` `Readonly` **batchJobRepository\_**: `Repository`<`BatchJob`\>
`Protected` `Readonly` **batchJobRepository\_**: `Repository`<`BatchJob`\>
#### Defined in
[medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L39)
[medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L39)
___
### batchJobStatusMapToProps
`Protected` **batchJobStatusMapToProps**: `Map`<`BatchJobStatus`, { `entityColumnName`: `string` ; `eventType`: `string` }\>
`Protected` **batchJobStatusMapToProps**: `Map`<`BatchJobStatus`, { `entityColumnName`: `string` ; `eventType`: `string` }\>
#### Defined in
[medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L43)
[medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L43)
___
### eventBus\_
`Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
`Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[medusa/src/services/batch-job.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L40)
[medusa/src/services/batch-job.ts:40](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L40)
___
### manager\_
`Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -110,23 +110,23 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### strategyResolver\_
`Protected` `Readonly` **strategyResolver\_**: [`StrategyResolverService`](StrategyResolverService.md)
`Protected` `Readonly` **strategyResolver\_**: [`StrategyResolverService`](StrategyResolverService.md)
#### Defined in
[medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L41)
[medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L41)
___
### transactionManager\_
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -134,13 +134,13 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
`Static` `Readonly` **Events**: `Object`
`Static` `Readonly` **Events**: `Object`
#### Type declaration
@@ -157,47 +157,47 @@ ___
#### Defined in
[medusa/src/services/batch-job.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L28)
[medusa/src/services/batch-job.ts:28](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L28)
## Accessors
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
-`EntityManager`:
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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` |
| `TResult` | `object` |
| `TError` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | 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 |
@@ -206,7 +206,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -214,98 +214,110 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### cancel
**cancel**(`batchJobOrId`): `Promise`<`BatchJob`\>
**cancel**(`batchJobOrId`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
#### Returns
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:270](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L270)
[medusa/src/services/batch-job.ts:270](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L270)
___
### complete
**complete**(`batchJobOrId`): `Promise`<`BatchJob`\>
**complete**(`batchJobOrId`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
#### Returns
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:252](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L252)
[medusa/src/services/batch-job.ts:252](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L252)
___
### confirm
**confirm**(`batchJobOrId`): `Promise`<`BatchJob`\>
**confirm**(`batchJobOrId`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
#### Returns
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:234](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L234)
[medusa/src/services/batch-job.ts:234](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L234)
___
### create
**create**(`data`): `Promise`<`BatchJob`\>
**create**(`data`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `data` | `BatchJobCreateProps` |
#### Returns
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:144](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L144)
[medusa/src/services/batch-job.ts:144](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L144)
___
### listAndCount
**listAndCount**(`selector?`, `config?`): `Promise`<[`BatchJob`[], `number`]\>
**listAndCount**(`selector?`, `config?`): `Promise`<[`BatchJob`[], `number`]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `selector` | `FilterableBatchJobProps` |
| `config` | `FindConfig`<`BatchJob`\> |
@@ -313,41 +325,47 @@ ___
`Promise`<[`BatchJob`[], `number`]\>
-`Promise`:
-`BatchJob[]`:
-`number`: (optional)
#### Defined in
[medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L132)
[medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L132)
___
### prepareBatchJobForProcessing
**prepareBatchJobForProcessing**(`data`, `req`): `Promise`<`CreateBatchJobInput`\>
**prepareBatchJobForProcessing**(`data`, `req`): `Promise`<`CreateBatchJobInput`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `data` | `CreateBatchJobInput` |
| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> |
| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> |
#### Returns
`Promise`<`CreateBatchJobInput`\>
-`Promise`:
#### Defined in
[medusa/src/services/batch-job.ts:367](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L367)
[medusa/src/services/batch-job.ts:367](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L367)
___
### retrieve
**retrieve**(`batchJobId`, `config?`): `Promise`<`BatchJob`\>
**retrieve**(`batchJobId`, `config?`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobId` | `string` |
| `config` | `FindConfig`<`BatchJob`\> |
@@ -355,20 +373,23 @@ ___
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:104](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L104)
[medusa/src/services/batch-job.ts:104](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L104)
___
### setFailed
**setFailed**(`batchJobOrId`, `error?`): `Promise`<`BatchJob`\>
**setFailed**(`batchJobOrId`, `error?`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
| `error?` | `string` \| `BatchJobResultError` |
@@ -376,84 +397,95 @@ ___
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:341](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L341)
[medusa/src/services/batch-job.ts:341](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L341)
___
### setPreProcessingDone
**setPreProcessingDone**(`batchJobOrId`): `Promise`<`BatchJob`\>
**setPreProcessingDone**(`batchJobOrId`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
#### Returns
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:288](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L288)
[medusa/src/services/batch-job.ts:288](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L288)
___
### setProcessing
**setProcessing**(`batchJobOrId`): `Promise`<`BatchJob`\>
**setProcessing**(`batchJobOrId`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
#### Returns
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:321](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L321)
[medusa/src/services/batch-job.ts:321](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L321)
___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
-`boolean`: (optional)
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### update
**update**(`batchJobOrId`, `data`): `Promise`<`BatchJob`\>
**update**(`batchJobOrId`, `data`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
| `data` | `Partial`<`Pick`<`BatchJob`, ``"context"`` \| ``"result"``\>\> |
@@ -461,20 +493,23 @@ ___
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:161](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L161)
[medusa/src/services/batch-job.ts:161](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L161)
___
### updateStatus
`Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<`BatchJob`\>
`Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<`BatchJob`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `batchJobOrId` | `string` \| `BatchJob` |
| `status` | `BatchJobStatus` |
@@ -482,30 +517,35 @@ ___
`Promise`<`BatchJob`\>
-`Promise`:
-`BatchJob`:
#### Defined in
[medusa/src/services/batch-job.ts:200](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/batch-job.ts#L200)
[medusa/src/services/batch-job.ts:200](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/batch-job.ts#L200)
___
### withTransaction
**withTransaction**(`transactionManager?`): [`BatchJobService`](BatchJobService.md)
**withTransaction**(`transactionManager?`): [`BatchJobService`](BatchJobService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`BatchJobService`](BatchJobService.md)
-`BatchJobService`:
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)