chore(docs): Generated References (#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

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-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions

View File

@@ -12,11 +12,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`Protected **new AbstractBatchJobStrategy**(__container__, __configModule__?, __moduleDeclaration__?)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -127,29 +127,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -157,6 +141,8 @@ 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
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -178,7 +164,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -210,7 +196,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -228,13 +214,13 @@ Promise&#60;TResult&#62;
___
### buildTemplate
#### buildTemplate
`Abstract **buildTemplate**(): Promise&#60;string&#62;`
Builds and returns a template file that can be downloaded and filled in
#### Returns
##### Returns
Promise&#60;string&#62;
@@ -252,10 +238,12 @@ Promise&#60;string&#62;
___
### handleProcessingError
#### handleProcessingError
`Protected **handleProcessingError**<TypeParameter T>(batchJobId, err, result): Promise&#60;void&#62;`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -268,7 +256,7 @@ ___
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -300,7 +288,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -318,13 +306,13 @@ Promise&#60;void&#62;
___
### preProcessBatchJob
#### preProcessBatchJob
`**preProcessBatchJob**(batchJobId): Promise&#60;void&#62;`
Method for pre-processing a batch job
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -338,7 +326,7 @@ Method for pre-processing a batch job
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -356,13 +344,13 @@ Promise&#60;void&#62;
___
### prepareBatchJobForProcessing
#### prepareBatchJobForProcessing
`**prepareBatchJobForProcessing**(batchJob, req): Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;`
Method for preparing a batch job for processing
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -385,7 +373,7 @@ Method for preparing a batch job for processing
}
]} />
#### Returns
##### Returns
Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
@@ -403,13 +391,13 @@ Promise&#60;[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)&#62;
___
### processJob
#### processJob
`Abstract **processJob**(batchJobId): Promise&#60;void&#62;`
Method does the actual processing of the job. Should report back on the progress of the operation.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -423,7 +411,7 @@ Method does the actual processing of the job. Should report back on the progress
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -441,11 +429,11 @@ Promise&#60;void&#62;
___
### shouldRetryOnProcessingError
#### shouldRetryOnProcessingError
`Protected **shouldRetryOnProcessingError**(batchJob, err): Promise&#60;boolean&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -468,7 +456,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -486,11 +474,11 @@ Promise&#60;boolean&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -504,7 +492,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -522,11 +510,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -540,7 +528,7 @@ ___
}
]} />
#### Returns
##### Returns
[AbstractBatchJobStrategy](AbstractBatchJobStrategy.mdx)