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 AnalyticsConfigService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -96,29 +96,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;`
@@ -126,6 +110,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",
@@ -147,7 +133,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -179,7 +165,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -197,13 +183,13 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(userId, data): Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;`
Creates an analytics config.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -226,7 +212,7 @@ Creates an analytics config.
}
]} />
#### Returns
##### Returns
Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
@@ -244,13 +230,13 @@ Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
___
### delete
#### delete
`**delete**(userId): Promise&#60;void&#62;`
Deletes an analytics config.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -264,7 +250,7 @@ Deletes an analytics config.
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -282,11 +268,11 @@ Promise&#60;void&#62;
___
### retrieve
#### retrieve
`**retrieve**(userId): Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -300,7 +286,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
@@ -318,11 +304,11 @@ Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -336,7 +322,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -354,13 +340,13 @@ ___
___
### update
#### update
`**update**(userId, update): Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;`
Updates an analytics config. If the config does not exist, it will be created instead.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -383,7 +369,7 @@ Updates an analytics config. If the config does not exist, it will be created in
}
]} />
#### Returns
##### Returns
Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
@@ -401,11 +387,11 @@ Promise&#60;[AnalyticsConfig](AnalyticsConfig.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [AnalyticsConfigService](AnalyticsConfigService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -419,7 +405,7 @@ ___
}
]} />
#### Returns
##### Returns
[AnalyticsConfigService](AnalyticsConfigService.mdx)