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

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new OrderEditItemChangeService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -141,29 +141,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;`
@@ -171,6 +155,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",
@@ -192,7 +178,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -224,7 +210,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -242,11 +228,11 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(data): Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -260,7 +246,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;
@@ -278,11 +264,11 @@ Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;
___
### delete
#### delete
`**delete**(itemChangeIds): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -296,7 +282,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -314,11 +300,11 @@ Promise&#60;void&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[OrderItemChange](OrderItemChange.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -341,7 +327,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderItemChange](OrderItemChange.mdx)[]&#62;
@@ -359,11 +345,11 @@ Promise&#60;[OrderItemChange](OrderItemChange.mdx)[]&#62;
___
### retrieve
#### retrieve
`**retrieve**(id, config?): Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -386,7 +372,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;
@@ -404,11 +390,11 @@ Promise&#60;[OrderItemChange](OrderItemChange.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -422,7 +408,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -440,11 +426,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [OrderEditItemChangeService](OrderEditItemChangeService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -458,7 +444,7 @@ ___
}
]} />
#### Returns
##### Returns
[OrderEditItemChangeService](OrderEditItemChangeService.mdx)