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 CustomShippingOptionService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -87,29 +87,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;`
@@ -117,6 +101,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",
@@ -138,7 +124,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -170,7 +156,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -188,12 +174,14 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**<TypeParameter T, TypeParameter TResult>(data): Promise&#60;TResult&#62;`
Creates a custom shipping option
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -215,7 +203,7 @@ Creates a custom shipping option
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -229,7 +217,7 @@ Creates a custom shipping option
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -247,13 +235,13 @@ Promise&#60;TResult&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;`
Fetches all custom shipping options based on the given selector
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -276,7 +264,7 @@ Fetches all custom shipping options based on the given selector
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;
@@ -294,13 +282,13 @@ Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)[]&#62;
___
### retrieve
#### retrieve
`**retrieve**(id, config?): Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;`
Retrieves a specific shipping option.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -323,7 +311,7 @@ Retrieves a specific shipping option.
}
]} />
#### Returns
##### Returns
Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;
@@ -341,11 +329,11 @@ Promise&#60;[CustomShippingOption](CustomShippingOption.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -359,7 +347,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -377,11 +365,11 @@ ___
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [CustomShippingOptionService](CustomShippingOptionService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -395,7 +383,7 @@ ___
}
]} />
#### Returns
##### Returns
[CustomShippingOptionService](CustomShippingOptionService.mdx)