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 AbstractNotificationService**(__container__, __configModule__?, __moduleDeclaration__?)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -109,29 +109,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;`
@@ -139,6 +123,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",
@@ -160,7 +146,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +178,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -210,11 +196,11 @@ Promise&#60;TResult&#62;
___
### getIdentifier
#### getIdentifier
`**getIdentifier**(): string`
#### Returns
##### Returns
`string`
@@ -232,11 +218,11 @@ ___
___
### resendNotification
#### resendNotification
`Abstract **resendNotification**(notification, config, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -268,7 +254,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
@@ -286,11 +272,11 @@ Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
___
### sendNotification
#### sendNotification
`Abstract **sendNotification**(event, data, attachmentGenerator): Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -322,7 +308,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
@@ -340,11 +326,11 @@ Promise&#60;[ReturnedData](../types/ReturnedData.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -358,7 +344,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -376,11 +362,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [AbstractNotificationService](AbstractNotificationService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -394,7 +380,7 @@ ___
}
]} />
#### Returns
##### Returns
[AbstractNotificationService](AbstractNotificationService.mdx)