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:
committed by
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -58,29 +58,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<TResult>`
|
||||
|
||||
@@ -88,6 +72,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",
|
||||
@@ -109,7 +95,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -141,7 +127,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<TResult>
|
||||
|
||||
@@ -159,13 +145,13 @@ Promise<TResult>
|
||||
|
||||
___
|
||||
|
||||
### buildTemplate
|
||||
#### buildTemplate
|
||||
|
||||
`**buildTemplate**(): Promise<string>`
|
||||
|
||||
Builds and returns a template file that can be downloaded and filled in
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<string>
|
||||
|
||||
@@ -183,13 +169,13 @@ Promise<string>
|
||||
|
||||
___
|
||||
|
||||
### preProcessBatchJob
|
||||
#### preProcessBatchJob
|
||||
|
||||
`**preProcessBatchJob**(batchJobId): Promise<void>`
|
||||
|
||||
Method for pre-processing a batch job
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -203,7 +189,7 @@ Method for pre-processing a batch job
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -221,13 +207,13 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
### prepareBatchJobForProcessing
|
||||
#### prepareBatchJobForProcessing
|
||||
|
||||
`**prepareBatchJobForProcessing**(batchJobEntity, req): Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)>`
|
||||
|
||||
Method for preparing a batch job for processing
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -250,7 +236,7 @@ Method for preparing a batch job for processing
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)>
|
||||
|
||||
@@ -268,13 +254,13 @@ Promise<[CreateBatchJobInput](../types/CreateBatchJobInput.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### processJob
|
||||
#### processJob
|
||||
|
||||
`**processJob**(batchJobId): Promise<void>`
|
||||
|
||||
Method does the actual processing of the job. Should report back on the progress of the operation.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -288,7 +274,7 @@ Method does the actual processing of the job. Should report back on the progress
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<void>
|
||||
|
||||
@@ -306,11 +292,11 @@ Promise<void>
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
#### shouldRetryTransaction\_
|
||||
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -324,7 +310,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
@@ -342,11 +328,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
#### withTransaction
|
||||
|
||||
`**withTransaction**(transactionManager?): [IBatchJobStrategy](IBatchJobStrategy.mdx)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -360,7 +346,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
[IBatchJobStrategy](IBatchJobStrategy.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user