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]
committed by
GitHub
GitHub
parent
dc6b815b12
commit
cdd42dbdcd
@@ -12,11 +12,11 @@ Handles draft orders
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
#### constructor
|
||||
|
||||
`**new DraftOrderService**(«destructured»)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -190,29 +190,13 @@ Handles draft orders
|
||||
|
||||
## 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<TResult>`
|
||||
|
||||
@@ -220,6 +204,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",
|
||||
@@ -241,7 +227,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -273,7 +259,7 @@ transaction manager is created.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<TResult>
|
||||
|
||||
@@ -291,13 +277,13 @@ Promise<TResult>
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
#### create
|
||||
|
||||
`**create**(data): Promise<[DraftOrder](DraftOrder.mdx)>`
|
||||
|
||||
Creates a draft order.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -311,7 +297,7 @@ Creates a draft order.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
@@ -329,13 +315,13 @@ Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
#### delete
|
||||
|
||||
`**delete**(draftOrderId): Promise<undefined \| [DraftOrder](DraftOrder.mdx)>`
|
||||
|
||||
Deletes draft order idempotently.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -349,7 +335,7 @@ Deletes draft order idempotently.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<undefined \| [DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
@@ -367,13 +353,13 @@ Promise<undefined \| [DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
#### list
|
||||
|
||||
`**list**(selector, config?): Promise<[DraftOrder](DraftOrder.mdx)[]>`
|
||||
|
||||
Lists draft orders
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -396,7 +382,7 @@ Lists draft orders
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[DraftOrder](DraftOrder.mdx)[]>
|
||||
|
||||
@@ -414,13 +400,13 @@ Promise<[DraftOrder](DraftOrder.mdx)[]>
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
#### listAndCount
|
||||
|
||||
`**listAndCount**(selector, config?): Promise<[[DraftOrder](DraftOrder.mdx)[], number]>`
|
||||
|
||||
Lists draft orders alongside the count
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -443,7 +429,7 @@ Lists draft orders alongside the count
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[[DraftOrder](DraftOrder.mdx)[], number]>
|
||||
|
||||
@@ -461,13 +447,13 @@ Promise<[[DraftOrder](DraftOrder.mdx)[], number]>
|
||||
|
||||
___
|
||||
|
||||
### registerCartCompletion
|
||||
#### registerCartCompletion
|
||||
|
||||
`**registerCartCompletion**(draftOrderId, orderId): Promise<UpdateResult>`
|
||||
|
||||
Registers a draft order as completed, when an order has been completed.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -490,7 +476,7 @@ Registers a draft order as completed, when an order has been completed.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<UpdateResult>
|
||||
|
||||
@@ -508,13 +494,13 @@ Promise<UpdateResult>
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
#### retrieve
|
||||
|
||||
`**retrieve**(draftOrderId, config?): Promise<[DraftOrder](DraftOrder.mdx)>`
|
||||
|
||||
Retrieves a draft order with the given id.
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -537,7 +523,7 @@ Retrieves a draft order with the given id.
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
@@ -555,13 +541,13 @@ Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartId
|
||||
#### retrieveByCartId
|
||||
|
||||
`**retrieveByCartId**(cartId, config?): Promise<[DraftOrder](DraftOrder.mdx)>`
|
||||
|
||||
Retrieves a draft order based on its associated cart id
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -584,7 +570,7 @@ Retrieves a draft order based on its associated cart id
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
@@ -602,11 +588,11 @@ Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
#### shouldRetryTransaction\_
|
||||
|
||||
`Protected **shouldRetryTransaction_**(err): boolean`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -620,7 +606,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
@@ -638,13 +624,13 @@ ___
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
#### update
|
||||
|
||||
`**update**(id, data): Promise<[DraftOrder](DraftOrder.mdx)>`
|
||||
|
||||
Updates a draft order with the given data
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -676,7 +662,7 @@ Updates a draft order with the given data
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
@@ -694,11 +680,11 @@ Promise<[DraftOrder](DraftOrder.mdx)>
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
#### withTransaction
|
||||
|
||||
`**withTransaction**(transactionManager?): [DraftOrderService](DraftOrderService.mdx)`
|
||||
|
||||
#### Parameters
|
||||
##### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -712,7 +698,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
##### Returns
|
||||
|
||||
[DraftOrderService](DraftOrderService.mdx)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user