asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
9e19359b5d683c48ff7eaabac039de97da520d33
medusa-store/www/apps/docs/content/references/services/classes/OrderEditService.md
github-actions[bot] 074055acbb chore(docs): Generated Services Reference (automated) (#5333) 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-10-09 19:57:05 +03:00

16 KiB
Raw Blame History

Class: OrderEditService

Hierarchy

  • TransactionBaseService

    ↳ OrderEditService

Constructors

constructor

• new OrderEditService(«destructured»)

Parameters

Name Type
«destructured» InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/order-edit.ts:75

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

medusa/src/services/order-edit.ts:69

inventoryService_

• Protected Readonly inventoryService_: undefined | IInventoryService

Defined in

medusa/src/services/order-edit.ts:73

lineItemAdjustmentService_

• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

medusa/src/services/order-edit.ts:71

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

medusa/src/services/order-edit.ts:68

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

newTotalsService_

• Protected Readonly newTotalsService_: NewTotalsService

Defined in

medusa/src/services/order-edit.ts:67

orderEditItemChangeService_

• Protected Readonly orderEditItemChangeService_: OrderEditItemChangeService

Defined in

medusa/src/services/order-edit.ts:72

orderEditRepository_

• Protected Readonly orderEditRepository_: Repository<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:63

orderService_

• Protected Readonly orderService_: OrderService

Defined in

medusa/src/services/order-edit.ts:65

taxProviderService_

• Protected Readonly taxProviderService_: TaxProviderService

Defined in

medusa/src/services/order-edit.ts:70

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

medusa/src/services/order-edit.ts:66

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Events

▪ Static Readonly Events: Object

Type declaration

Name Type
CANCELED string
CONFIRMED string
CREATED string
DECLINED string
REQUESTED string
UPDATED string

Defined in

medusa/src/services/order-edit.ts:54

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

addLineItem

▸ addLineItem(orderEditId, data): Promise<void>

Parameters

Name Type
orderEditId string
data AddOrderEditLineItemInput

Returns

Promise<void>

Defined in

medusa/src/services/order-edit.ts:541

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(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.

Type parameters

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult> the transactional work to be done
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult> the isolation level to be used for the work.
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult> Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

cancel

▸ cancel(orderEditId, context?): Promise<OrderEdit>

Parameters

Name Type
orderEditId string
context Object
context.canceledBy? string

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:687

confirm

▸ confirm(orderEditId, context?): Promise<OrderEdit>

Parameters

Name Type
orderEditId string
context Object
context.confirmedBy? string

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:726

create

▸ create(data, context): Promise<OrderEdit>

Parameters

Name Type
data CreateOrderEditInput
context Object
context.createdBy string

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:162

decline

▸ decline(orderEditId, context): Promise<OrderEdit>

Parameters

Name Type
orderEditId string
context Object
context.declinedBy? string
context.declinedReason? string

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:260

decorateTotals

▸ decorateTotals(orderEdit): Promise<OrderEdit>

Parameters

Name Type
orderEdit OrderEdit

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:490

delete

▸ delete(id): Promise<void>

Parameters

Name Type
id string

Returns

Promise<void>

Defined in

medusa/src/services/order-edit.ts:238

deleteClonedItems

▸ Protected deleteClonedItems(orderEditId): Promise<void>

Parameters

Name Type
orderEditId string

Returns

Promise<void>

Defined in

medusa/src/services/order-edit.ts:808

deleteItemChange

▸ deleteItemChange(orderEditId, itemChangeId): Promise<void>

Parameters

Name Type
orderEditId string
itemChangeId string

Returns

Promise<void>

Defined in

medusa/src/services/order-edit.ts:613

list

▸ list(selector, config?): Promise<OrderEdit[]>

Parameters

Name Type
selector Selector<OrderEdit>
config? FindConfig<OrderEdit>

Returns

Promise<OrderEdit[]>

Defined in

medusa/src/services/order-edit.ts:154

listAndCount

▸ listAndCount(selector, config?): Promise<[OrderEdit[], number]>

Parameters

Name Type
selector Selector<OrderEdit> & { q?: string }
config? FindConfig<OrderEdit>

Returns

Promise<[OrderEdit[], number]>

Defined in

medusa/src/services/order-edit.ts:130

refreshAdjustments

▸ refreshAdjustments(orderEditId, config?): Promise<void>

Parameters

Name Type Default value
orderEditId string undefined
config Object undefined
config.preserveCustomAdjustments boolean false

Returns

Promise<void>

Defined in

medusa/src/services/order-edit.ts:439

removeLineItem

▸ removeLineItem(orderEditId, lineItemId): Promise<void>

Parameters

Name Type
orderEditId string
lineItemId string

Returns

Promise<void>

Defined in

medusa/src/services/order-edit.ts:382

requestConfirmation

▸ requestConfirmation(orderEditId, context?): Promise<OrderEdit>

Parameters

Name Type
orderEditId string
context Object
context.requestedBy? string

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:645

retrieve

▸ retrieve(orderEditId, config?): Promise<OrderEdit>

Parameters

Name Type
orderEditId string
config FindConfig<OrderEdit>

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:102

retrieveActive

▸ Protected retrieveActive(orderId, config?): Promise<undefined | null | OrderEdit>

Parameters

Name Type
orderId string
config FindConfig<OrderEdit>

Returns

Promise<undefined | null | OrderEdit>

Defined in

medusa/src/services/order-edit.ts:788

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

update

▸ update(orderEditId, data): Promise<OrderEdit>

Parameters

Name Type
orderEditId string
data DeepPartial<OrderEdit>

Returns

Promise<OrderEdit>

Defined in

medusa/src/services/order-edit.ts:211

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

Name Type
orderEditId string
itemId string
data Object
data.quantity number

Returns

Promise<void>

Defined in

medusa/src/services/order-edit.ts:309

withTransaction

▸ withTransaction(transactionManager?): OrderEditService

Parameters

Name Type
transactionManager? EntityManager

Returns

OrderEditService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

isOrderEditActive

▸ Static Private isOrderEditActive(orderEdit): boolean

Parameters

Name Type
orderEdit OrderEdit

Returns

boolean

Defined in

medusa/src/services/order-edit.ts:860

Reference in New Issue View Git Blame Copy Permalink