asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5743)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

178
www/apps/docs/content/references/services/classes/OrderEditService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new OrderEditService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -222,55 +222,23 @@ 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]
___
### inventoryService\_
#### inventoryService\_
`Protected get**inventoryService_**(): undefined \| [IInventoryService](../interfaces/IInventoryService.mdx)`
#### Returns
`undefined` \| [IInventoryService](../interfaces/IInventoryService.mdx)
<ParameterTypes parameters={[
{
"name": "undefined \\| IInventoryService",
"type": "`undefined` \\| [IInventoryService](../interfaces/IInventoryService.mdx)",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **inventoryService\_**: [object Object]
## Methods
### addLineItem
#### addLineItem
`**addLineItem**(orderEditId, data): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -293,7 +261,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -311,7 +279,7 @@ Promise&#60;void&#62;
___
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -319,6 +287,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",
@@ -340,7 +310,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -372,7 +342,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -390,11 +360,11 @@ Promise&#60;TResult&#62;
___
### cancel
#### cancel
`**cancel**(orderEditId, context?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -426,7 +396,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -444,11 +414,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### confirm
#### confirm
`**confirm**(orderEditId, context?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -480,7 +450,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -498,11 +468,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### create
#### create
`**create**(data, context): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -534,7 +504,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -552,11 +522,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### decline
#### decline
`**decline**(orderEditId, context): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -597,7 +567,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -615,11 +585,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### decorateTotals
#### decorateTotals
`**decorateTotals**(orderEdit): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -633,7 +603,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -651,11 +621,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### delete
#### delete
`**delete**(id): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -669,7 +639,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -687,11 +657,11 @@ Promise&#60;void&#62;
___
### deleteClonedItems
#### deleteClonedItems
`Protected **deleteClonedItems**(orderEditId): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -705,7 +675,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -723,11 +693,11 @@ Promise&#60;void&#62;
___
### deleteItemChange
#### deleteItemChange
`**deleteItemChange**(orderEditId, itemChangeId): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -750,7 +720,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -768,11 +738,11 @@ Promise&#60;void&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[OrderEdit](OrderEdit.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -795,7 +765,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)[]&#62;
@@ -813,11 +783,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)[]&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[OrderEdit](OrderEdit.mdx)[], number]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -840,7 +810,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[[OrderEdit](OrderEdit.mdx)[], number]&#62;
@@ -858,11 +828,11 @@ Promise&#60;[[OrderEdit](OrderEdit.mdx)[], number]&#62;
___
### refreshAdjustments
#### refreshAdjustments
`**refreshAdjustments**(orderEditId, config?): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -894,7 +864,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -912,11 +882,11 @@ Promise&#60;void&#62;
___
### removeLineItem
#### removeLineItem
`**removeLineItem**(orderEditId, lineItemId): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -939,7 +909,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -957,11 +927,11 @@ Promise&#60;void&#62;
___
### requestConfirmation
#### requestConfirmation
`**requestConfirmation**(orderEditId, context?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -993,7 +963,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -1011,11 +981,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(orderEditId, config?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1038,7 +1008,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -1056,11 +1026,11 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### retrieveActive
#### retrieveActive
`Protected **retrieveActive**(orderId, config?): Promise&#60;undefined \| null \| [OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1083,7 +1053,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;undefined \| null \| [OrderEdit](OrderEdit.mdx)&#62;
@@ -1101,11 +1071,11 @@ Promise&#60;undefined \| null \| [OrderEdit](OrderEdit.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1119,7 +1089,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -1137,11 +1107,11 @@ ___
___
### update
#### update
`**update**(orderEditId, data): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1164,7 +1134,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
@@ -1182,7 +1152,7 @@ Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
___
### updateLineItem
#### updateLineItem
`**updateLineItem**(orderEditId, itemId, data): Promise&#60;void&#62;`
@@ -1190,7 +1160,7 @@ Create or update order edit item change line item and apply the quantity
- If the item change already exists then update the quantity of the line item as well as the line adjustments
- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1231,7 +1201,7 @@ Create or update order edit item change line item and apply the quantity
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -1249,11 +1219,11 @@ Promise&#60;void&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [OrderEditService](OrderEditService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1267,7 +1237,7 @@ ___
}
]} />
#### Returns
##### Returns
[OrderEditService](OrderEditService.mdx)
@@ -1285,11 +1255,11 @@ ___
___
### isOrderEditActive
#### isOrderEditActive
`Static Private **isOrderEditActive**(orderEdit): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1303,7 +1273,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`