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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### constructor
**new OrderEditService**(`«destructured»`)
`**new OrderEditService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-20.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-20.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "eventBusService_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemAdjustmentService_",
"type": "[`LineItemAdjustmentService`](LineItemAdjustmentService.mdx)",
"type": "[LineItemAdjustmentService](LineItemAdjustmentService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemService_",
"type": "[`LineItemService`](LineItemService.mdx)",
"type": "[LineItemService](LineItemService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "newTotalsService_",
"type": "[`NewTotalsService`](NewTotalsService.mdx)",
"type": "[NewTotalsService](NewTotalsService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "orderEditItemChangeService_",
"type": "[`OrderEditItemChangeService`](OrderEditItemChangeService.mdx)",
"type": "[OrderEditItemChangeService](OrderEditItemChangeService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "orderEditRepository_",
"type": "`Repository`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Repository&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "orderService_",
"type": "[`OrderService`](OrderService.mdx)",
"type": "[OrderService](OrderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "taxProviderService_",
"type": "[`TaxProviderService`](TaxProviderService.mdx)",
"type": "[TaxProviderService](TaxProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "totalsService_",
"type": "[`TotalsService`](TotalsService.mdx)",
"type": "[TotalsService](TotalsService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -224,16 +224,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -246,16 +246,16 @@ ___
### inventoryService\_
`Protected` `get` **inventoryService_**(): `undefined` \| [`IInventoryService`](../interfaces/IInventoryService.mdx)
`Protected get**inventoryService_**(): undefined \| [IInventoryService](../interfaces/IInventoryService.mdx)`
#### Returns
`undefined` \| [`IInventoryService`](../interfaces/IInventoryService.mdx)
`undefined` \| [IInventoryService](../interfaces/IInventoryService.mdx)
<ParameterTypes parameters={[
{
"name": "undefined \\| IInventoryService",
"type": "`undefined` \\| [`IInventoryService`](../interfaces/IInventoryService.mdx)",
"type": "`undefined` \\| [IInventoryService](../interfaces/IInventoryService.mdx)",
"optional": true,
"defaultValue": "",
"description": "",
@@ -268,7 +268,7 @@ ___
### addLineItem
**addLineItem**(`orderEditId`, `data`): `Promise`<`void`\>
`**addLineItem**(orderEditId, data): Promise&#60;void&#62;`
#### Parameters
@@ -284,7 +284,7 @@ ___
},
{
"name": "data",
"type": "[`AddOrderEditLineItemInput`](../types/AddOrderEditLineItemInput.mdx)",
"type": "[AddOrderEditLineItemInput](../types/AddOrderEditLineItemInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -295,12 +295,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -313,7 +313,7 @@ ___
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -345,7 +345,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -354,7 +354,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -363,7 +363,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -374,12 +374,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -392,7 +392,7 @@ ___
### cancel
**cancel**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**cancel**(orderEditId, context?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -428,12 +428,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -446,7 +446,7 @@ ___
### confirm
**confirm**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**confirm**(orderEditId, context?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -482,12 +482,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -500,14 +500,14 @@ ___
### create
**create**(`data`, `context`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**create**(data, context): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateOrderEditInput`](../types/CreateOrderEditInput.mdx)",
"type": "[CreateOrderEditInput](../types/CreateOrderEditInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -536,12 +536,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -554,7 +554,7 @@ ___
### decline
**decline**(`orderEditId`, `context`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**decline**(orderEditId, context): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -599,12 +599,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -617,14 +617,14 @@ ___
### decorateTotals
**decorateTotals**(`orderEdit`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**decorateTotals**(orderEdit): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "orderEdit",
"type": "[`OrderEdit`](OrderEdit.mdx)",
"type": "[OrderEdit](OrderEdit.mdx)",
"description": "Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order.",
"optional": false,
"defaultValue": "",
@@ -635,12 +635,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -653,7 +653,7 @@ ___
### delete
**delete**(`id`): `Promise`<`void`\>
`**delete**(id): Promise&#60;void&#62;`
#### Parameters
@@ -671,12 +671,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -689,7 +689,7 @@ ___
### deleteClonedItems
`Protected` **deleteClonedItems**(`orderEditId`): `Promise`<`void`\>
`Protected **deleteClonedItems**(orderEditId): Promise&#60;void&#62;`
#### Parameters
@@ -707,12 +707,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -725,7 +725,7 @@ ___
### deleteItemChange
**deleteItemChange**(`orderEditId`, `itemChangeId`): `Promise`<`void`\>
`**deleteItemChange**(orderEditId, itemChangeId): Promise&#60;void&#62;`
#### Parameters
@@ -752,12 +752,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -770,14 +770,14 @@ ___
### list
**list**(`selector`, `config?`): `Promise`<[`OrderEdit`](OrderEdit.mdx)[]\>
`**list**(selector, config?): Promise&#60;[OrderEdit](OrderEdit.mdx)[]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -786,7 +786,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -797,12 +797,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)[]\>
Promise&#60;[OrderEdit](OrderEdit.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)[]\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -815,14 +815,14 @@ ___
### listAndCount
**listAndCount**(`selector`, `config?`): `Promise`<[[`OrderEdit`](OrderEdit.mdx)[], `number`]\>
`**listAndCount**(selector, config?): Promise&#60;[[OrderEdit](OrderEdit.mdx)[], number]&#62;`
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`OrderEdit`](OrderEdit.mdx)\\> & { `q?`: `string` }",
"type": "[Selector](../types/Selector.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62; & `&#123; q?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -831,7 +831,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -842,12 +842,12 @@ ___
#### Returns
`Promise`<[[`OrderEdit`](OrderEdit.mdx)[], `number`]\>
Promise&#60;[[OrderEdit](OrderEdit.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`OrderEdit`](OrderEdit.mdx)[], `number`]\\>",
"type": "Promise&#60;[[OrderEdit](OrderEdit.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -860,7 +860,7 @@ ___
### refreshAdjustments
**refreshAdjustments**(`orderEditId`, `config?`): `Promise`<`void`\>
`**refreshAdjustments**(orderEditId, config?): Promise&#60;void&#62;`
#### Parameters
@@ -896,12 +896,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -914,7 +914,7 @@ ___
### removeLineItem
**removeLineItem**(`orderEditId`, `lineItemId`): `Promise`<`void`\>
`**removeLineItem**(orderEditId, lineItemId): Promise&#60;void&#62;`
#### Parameters
@@ -941,12 +941,12 @@ ___
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -959,7 +959,7 @@ ___
### requestConfirmation
**requestConfirmation**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**requestConfirmation**(orderEditId, context?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -995,12 +995,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1013,7 +1013,7 @@ ___
### retrieve
**retrieve**(`orderEditId`, `config?`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**retrieve**(orderEditId, config?): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -1029,7 +1029,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -1040,12 +1040,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1058,7 +1058,7 @@ ___
### retrieveActive
`Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| ``null`` \| [`OrderEdit`](OrderEdit.mdx)\>
`Protected **retrieveActive**(orderId, config?): Promise&#60;undefined \| `null` \| [OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -1074,7 +1074,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "{}",
@@ -1085,12 +1085,12 @@ ___
#### Returns
`Promise`<`undefined` \| ``null`` \| [`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;undefined \| `null` \| [OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`undefined` \\| ``null`` \\| [`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;undefined \\| `null` \\| [OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1103,14 +1103,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1139,7 +1139,7 @@ ___
### update
**update**(`orderEditId`, `data`): `Promise`<[`OrderEdit`](OrderEdit.mdx)\>
`**update**(orderEditId, data): Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -1155,7 +1155,7 @@ ___
},
{
"name": "data",
"type": "`DeepPartial`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "DeepPartial&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1166,12 +1166,12 @@ ___
#### Returns
`Promise`<[`OrderEdit`](OrderEdit.mdx)\>
Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`OrderEdit`](OrderEdit.mdx)\\>",
"type": "Promise&#60;[OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1184,7 +1184,7 @@ ___
### updateLineItem
**updateLineItem**(`orderEditId`, `itemId`, `data`): `Promise`<`void`\>
`**updateLineItem**(orderEditId, itemId, data): Promise&#60;void&#62;`
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
@@ -1233,12 +1233,12 @@ Create or update order edit item change line item and apply the quantity
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1251,14 +1251,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`OrderEditService`](OrderEditService.mdx)
`**withTransaction**(transactionManager?): [OrderEditService](OrderEditService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1269,12 +1269,12 @@ ___
#### Returns
[`OrderEditService`](OrderEditService.mdx)
[OrderEditService](OrderEditService.mdx)
<ParameterTypes parameters={[
{
"name": "default",
"type": "[`OrderEditService`](OrderEditService.mdx)",
"type": "[OrderEditService](OrderEditService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1287,14 +1287,14 @@ ___
### isOrderEditActive
`Static` `Private` **isOrderEditActive**(`orderEdit`): `boolean`
`Static Private **isOrderEditActive**(orderEdit): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "orderEdit",
"type": "[`OrderEdit`](OrderEdit.mdx)",
"type": "[OrderEdit](OrderEdit.mdx)",
"description": "Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order.",
"optional": false,
"defaultValue": "",