--- displayed_sidebar: servicesSidebar --- import ParameterTypes from "@site/src/components/ParameterTypes" # OrderEditService ## Constructors ### constructor `**new OrderEditService**(«destructured»)` #### Parameters ## Properties `", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "__container__", "type": "`any`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "__moduleDeclaration__", "type": "`Record`", "description": "", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "eventBusService_", "type": "[EventBusService](EventBusService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "lineItemAdjustmentService_", "type": "[LineItemAdjustmentService](LineItemAdjustmentService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "lineItemService_", "type": "[LineItemService](LineItemService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "manager_", "type": "EntityManager", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "newTotalsService_", "type": "[NewTotalsService](NewTotalsService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orderEditItemChangeService_", "type": "[OrderEditItemChangeService](OrderEditItemChangeService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orderEditRepository_", "type": "Repository<[OrderEdit](OrderEdit.mdx)>", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "orderService_", "type": "[OrderService](OrderService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "taxProviderService_", "type": "[TaxProviderService](TaxProviderService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "totalsService_", "type": "[TotalsService](TotalsService.mdx)", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "transactionManager_", "type": "`undefined` \\| EntityManager", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "Events", "type": "`object`", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "Events.CANCELED", "type": "`string`", "description": "", "optional": false, "defaultValue": "\"order-edit.canceled\"", "expandable": false, "children": [] }, { "name": "Events.CONFIRMED", "type": "`string`", "description": "", "optional": false, "defaultValue": "\"order-edit.confirmed\"", "expandable": false, "children": [] }, { "name": "Events.CREATED", "type": "`string`", "description": "", "optional": false, "defaultValue": "\"order-edit.created\"", "expandable": false, "children": [] }, { "name": "Events.DECLINED", "type": "`string`", "description": "", "optional": false, "defaultValue": "\"order-edit.declined\"", "expandable": false, "children": [] }, { "name": "Events.REQUESTED", "type": "`string`", "description": "", "optional": false, "defaultValue": "\"order-edit.requested\"", "expandable": false, "children": [] }, { "name": "Events.UPDATED", "type": "`string`", "description": "", "optional": false, "defaultValue": "\"order-edit.updated\"", "expandable": false, "children": [] } ]} /> ## Accessors ### activeManager\_ `Protected get**activeManager_**(): EntityManager` #### Returns EntityManager ___ ### inventoryService\_ `Protected get**inventoryService_**(): undefined \| [IInventoryService](../interfaces/IInventoryService.mdx)` #### Returns `undefined` \| [IInventoryService](../interfaces/IInventoryService.mdx) ## Methods ### addLineItem `**addLineItem**(orderEditId, data): Promise<void>` #### Parameters #### Returns Promise<void> ___ ### atomicPhase\_ `Protected **atomicPhase_**(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>` 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. #### Parameters Promise<TResult>", "description": "the transactional work to be done", "optional": false, "defaultValue": "", "expandable": false, "children": [] }, { "name": "isolationOrErrorHandler", "type": "`IsolationLevel` \\| (`error`: `TError`) => Promise<void \\| TResult>", "description": "the isolation level to be used for the work.", "optional": true, "defaultValue": "", "expandable": false, "children": [] }, { "name": "maybeErrorHandlerOrDontFail", "type": "(`error`: `TError`) => Promise<void \\| TResult>", "description": "Potential error handler", "optional": true, "defaultValue": "", "expandable": false, "children": [] } ]} /> #### Returns Promise<TResult> ___ ### cancel `**cancel**(orderEditId, context?): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### confirm `**confirm**(orderEditId, context?): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### create `**create**(data, context): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### decline `**decline**(orderEditId, context): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### decorateTotals `**decorateTotals**(orderEdit): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### delete `**delete**(id): Promise<void>` #### Parameters #### Returns Promise<void> ___ ### deleteClonedItems `Protected **deleteClonedItems**(orderEditId): Promise<void>` #### Parameters #### Returns Promise<void> ___ ### deleteItemChange `**deleteItemChange**(orderEditId, itemChangeId): Promise<void>` #### Parameters #### Returns Promise<void> ___ ### list `**list**(selector, config?): Promise<[OrderEdit](OrderEdit.mdx)[]>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)[]> ___ ### listAndCount `**listAndCount**(selector, config?): Promise<[[OrderEdit](OrderEdit.mdx)[], number]>` #### Parameters #### Returns Promise<[[OrderEdit](OrderEdit.mdx)[], number]> ___ ### refreshAdjustments `**refreshAdjustments**(orderEditId, config?): Promise<void>` #### Parameters #### Returns Promise<void> ___ ### removeLineItem `**removeLineItem**(orderEditId, lineItemId): Promise<void>` #### Parameters #### Returns Promise<void> ___ ### requestConfirmation `**requestConfirmation**(orderEditId, context?): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### retrieve `**retrieve**(orderEditId, config?): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### retrieveActive `Protected **retrieveActive**(orderId, config?): Promise<undefined \| null \| [OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<undefined \| null \| [OrderEdit](OrderEdit.mdx)> ___ ### shouldRetryTransaction\_ `Protected **shouldRetryTransaction_**(err): boolean` #### Parameters ` \\| ``{ code: string }``", "description": "", "optional": false, "defaultValue": "", "expandable": false, "children": [] } ]} /> #### Returns `boolean` ___ ### update `**update**(orderEditId, data): Promise<[OrderEdit](OrderEdit.mdx)>` #### Parameters #### Returns Promise<[OrderEdit](OrderEdit.mdx)> ___ ### updateLineItem `**updateLineItem**(orderEditId, itemId, data): Promise<void>` 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 #### Returns Promise<void> ___ ### withTransaction `**withTransaction**(transactionManager?): [OrderEditService](OrderEditService.mdx)` #### Parameters #### Returns [OrderEditService](OrderEditService.mdx) ___ ### isOrderEditActive `Static Private **isOrderEditActive**(orderEdit): boolean` #### Parameters #### Returns `boolean`