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 CurrencyService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -123,29 +123,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;`
@@ -153,6 +137,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",
@@ -174,7 +160,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -206,7 +192,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -224,14 +210,14 @@ Promise&#60;TResult&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[Currency](Currency.mdx)[], number]&#62;`
Lists currencies based on the provided parameters and includes the count of
currencies that match the query.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -254,7 +240,7 @@ currencies that match the query.
}
]} />
#### Returns
##### Returns
Promise&#60;[[Currency](Currency.mdx)[], number]&#62;
@@ -272,13 +258,13 @@ Promise&#60;[[Currency](Currency.mdx)[], number]&#62;
___
### retrieveByCode
#### retrieveByCode
`**retrieveByCode**(code): Promise&#60;[Currency](Currency.mdx)&#62;`
Return the currency
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -292,7 +278,7 @@ Return the currency
}
]} />
#### Returns
##### Returns
Promise&#60;[Currency](Currency.mdx)&#62;
@@ -310,11 +296,11 @@ Promise&#60;[Currency](Currency.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -328,7 +314,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -346,13 +332,13 @@ ___
___
### update
#### update
`**update**(code, data): Promise&#60;undefined \| [Currency](Currency.mdx)&#62;`
Update a currency
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -375,7 +361,7 @@ Update a currency
}
]} />
#### Returns
##### Returns
Promise&#60;undefined \| [Currency](Currency.mdx)&#62;
@@ -393,11 +379,11 @@ Promise&#60;undefined \| [Currency](Currency.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [CurrencyService](CurrencyService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -411,7 +397,7 @@ ___
}
]} />
#### Returns
##### Returns
[CurrencyService](CurrencyService.mdx)