asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
907f7f83d8fdc63154a8a8fee11eb902a16efdf5
medusa-store/docs/content/references/services/classes/OrderEditService.md
github-actions[bot] 6aee2e2265 chore(docs): Generated Services Reference (automated) (#2663) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2022-11-28 11:02:51 +02:00

19 KiB
Raw Blame History

Class: OrderEditService

Hierarchy

  • TransactionBaseService

    ↳ OrderEditService

Constructors

constructor

• new OrderEditService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

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

Properties

__configModule__

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

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

packages/medusa/src/services/order-edit.ts:60

lineItemAdjustmentService_

• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

packages/medusa/src/services/order-edit.ts:62

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

packages/medusa/src/services/order-edit.ts:59

manager_

• Protected Readonly manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/order-edit.ts:52

orderEditItemChangeService_

• Protected Readonly orderEditItemChangeService_: OrderEditItemChangeService

Defined in

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

orderEditRepository_

• Protected Readonly orderEditRepository_: typeof OrderEditRepository

Defined in

packages/medusa/src/services/order-edit.ts:55

orderService_

• Protected Readonly orderService_: OrderService

Defined in

packages/medusa/src/services/order-edit.ts:57

taxProviderService_

• Protected Readonly taxProviderService_: TaxProviderService

Defined in

packages/medusa/src/services/order-edit.ts:61

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

packages/medusa/src/services/order-edit.ts:58

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/order-edit.ts:53

Events

▪ Static Readonly Events: Object

Type declaration

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

Defined in

packages/medusa/src/services/order-edit.ts:43

Methods

addLineItem

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

Parameters

Name Type
orderEditId string
data AddOrderEditLineItemInput

Returns

Promise<void>

Defined in

packages/medusa/src/services/order-edit.ts:547

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

packages/medusa/src/interfaces/transaction-base-service.ts:48

cancel

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

Parameters

Name Type
orderEditId string
context Object
context.loggedInUserId? string

Returns

Promise<OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:691

confirm

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

Parameters

Name Type
orderEditId string
context Object
context.loggedInUserId? string

Returns

Promise<OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:730

create

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

Parameters

Name Type
data CreateOrderEditInput
context Object
context.loggedInUserId string

Returns

Promise<OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:207

decline

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

Parameters

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

Returns

Promise<OrderEdit>

Defined in

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

decorateTotals

▸ decorateTotals(orderEdit): Promise<OrderEdit>

Parameters

Name Type
orderEdit OrderEdit

Returns

Promise<OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:533

delete

▸ delete(id): Promise<void>

Parameters

Name Type
id string

Returns

Promise<void>

Defined in

packages/medusa/src/services/order-edit.ts:285

deleteClonedItems

▸ Protected deleteClonedItems(orderEditId): Promise<void>

Parameters

Name Type
orderEditId string

Returns

Promise<void>

Defined in

packages/medusa/src/services/order-edit.ts:803

deleteItemChange

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

Parameters

Name Type
orderEditId string
itemChangeId string

Returns

Promise<void>

Defined in

packages/medusa/src/services/order-edit.ts:619

getTotals

▸ getTotals(orderEditId): Promise<{ difference_due: number ; discount_total: number ; gift_card_tax_total: number ; gift_card_total: number ; shipping_total: number ; subtotal: number ; tax_total: null | number ; total: number }>

Compute and return the different totals from the order edit id

Parameters

Name Type
orderEditId string

Returns

Promise<{ difference_due: number ; discount_total: number ; gift_card_tax_total: number ; gift_card_total: number ; shipping_total: number ; subtotal: number ; tax_total: null | number ; total: number }>

Defined in

packages/medusa/src/services/order-edit.ts:148

list

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

Parameters

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

Returns

Promise<OrderEdit[]>

Defined in

packages/medusa/src/services/order-edit.ts:136

listAndCount

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

Parameters

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

Returns

Promise<[OrderEdit[], number]>

Defined in

packages/medusa/src/services/order-edit.ts:112

refreshAdjustments

▸ refreshAdjustments(orderEditId): Promise<void>

Parameters

Name Type
orderEditId string

Returns

Promise<void>

Defined in

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

removeLineItem

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

Parameters

Name Type
orderEditId string
lineItemId string

Returns

Promise<void>

Defined in

packages/medusa/src/services/order-edit.ts:433

requestConfirmation

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

Parameters

Name Type
orderEditId string
context Object
context.loggedInUserId? string

Returns

Promise<OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:651

retrieve

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

Parameters

Name Type
orderEditId string
config FindConfig<OrderEdit>

Returns

Promise<OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:90

retrieveActive

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

Parameters

Name Type
orderId string
config FindConfig<OrderEdit>

Returns

Promise<undefined | OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:782

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:29

update

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

Parameters

Name Type
orderEditId string
data Object
data.canceled_at? { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.canceled_by? string
data.changes? (undefined | { type?: OrderEditItemChangeType | undefined; order_edit_id?: string | undefined; order_edit?: { order_id?: string | undefined; order?: { readonly object?: "order" | undefined; ... 51 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 27 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 7 ...)[]
data.confirmed_at? { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.confirmed_by? string
data.created_at? { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.created_by? string
data.declined_at? { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.declined_by? string
data.declined_reason? string
data.difference_due? number
data.discount_total? number
data.gift_card_tax_total? number
data.gift_card_total? number
data.id? string
data.internal_note? string
data.items? (undefined | { cart_id?: string | undefined; cart?: { readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; billing_address?: { customer_id?: string | ... 1 more ... | undefined; ... 16 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 36 more ...; updated_at?: {...)[]
data.order? { readonly object?: "order" | undefined; status?: OrderStatus | undefined; fulfillment_status?: FulfillmentStatus | undefined; payment_status?: PaymentStatus | undefined; ... 48 more ...; updated_at?: { ...; } | undefined; }
data.order_id? string
data.payment_collection? { type?: PaymentCollectionType | undefined; status?: PaymentCollectionStatus | undefined; description?: string | null | undefined; ... 13 more ...; updated_at?: { ...; } | undefined; }
data.payment_collection_id? string
data.requested_at? { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.requested_by? string
data.shipping_total? number
data.status? OrderEditStatus
data.subtotal? number
data.tax_total? null | number
data.total? number
data.updated_at? { toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
data.loadStatus?

Returns

Promise<OrderEdit>

Defined in

packages/medusa/src/services/order-edit.ts:256

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

packages/medusa/src/services/order-edit.ts:360

withTransaction

▸ withTransaction(transactionManager?): OrderEditService

Parameters

Name Type
transactionManager? EntityManager

Returns

OrderEditService

Inherited from

TransactionBaseService.withTransaction

Defined in

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

isOrderEditActive

▸ Static Private isOrderEditActive(orderEdit): boolean

Parameters

Name Type
orderEdit OrderEdit

Returns

boolean

Defined in

packages/medusa/src/services/order-edit.ts:849

Reference in New Issue View Git Blame Copy Permalink