10 KiB
Class: DraftOrderService
Handles draft orders
implements {BaseService}
Hierarchy
-
TransactionBaseService<DraftOrderService>↳
DraftOrderService
Constructors
constructor
• new DraftOrderService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
Overrides
TransactionBaseService<DraftOrderService>.constructor
Defined in
Properties
cartService_
• Protected Readonly cartService_: CartService
Defined in
configModule
• Protected Optional Readonly configModule: Record<string, unknown>
Inherited from
TransactionBaseService.configModule
container
• Protected Readonly container: unknown
Inherited from
TransactionBaseService.container
draftOrderRepository_
• Protected Readonly draftOrderRepository_: typeof DraftOrderRepository
Defined in
eventBus_
• Protected Readonly eventBus_: EventBusService
Defined in
lineItemService_
• Protected Readonly lineItemService_: LineItemService
Defined in
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
orderRepository_
• Protected Readonly orderRepository_: typeof OrderRepository
Defined in
paymentRepository_
• Protected Readonly paymentRepository_: typeof PaymentRepository
Defined in
productVariantService_
• Protected Readonly productVariantService_: ProductVariantService
Defined in
shippingOptionService_
• Protected Readonly shippingOptionService_: ShippingOptionService
Defined in
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
Events
▪ Static Readonly Events: Object
Type declaration
| Name | Type |
|---|---|
CREATED |
string |
UPDATED |
string |
Defined in
Methods
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
interfaces/transaction-base-service.ts:53
create
▸ create(data): Promise<DraftOrder>
Creates a draft order.
Parameters
| Name | Type | Description |
|---|---|---|
data |
AdminPostDraftOrdersReq |
data to create draft order from |
Returns
Promise<DraftOrder>
the created draft order
Defined in
delete
▸ delete(draftOrderId): Promise<undefined | DraftOrder>
Deletes draft order idempotently.
Parameters
| Name | Type | Description |
|---|---|---|
draftOrderId |
string |
id of draft order to delete |
Returns
Promise<undefined | DraftOrder>
empty promise
Defined in
list
▸ list(selector, config?): Promise<DraftOrder[]>
Lists draft orders
Parameters
| Name | Type | Description |
|---|---|---|
selector |
any |
query object for find |
config |
FindConfig<DraftOrder> |
configurable attributes for find |
Returns
Promise<DraftOrder[]>
list of draft orders
Defined in
listAndCount
▸ listAndCount(selector, config?): Promise<[DraftOrder[], number]>
Lists draft orders alongside the count
Parameters
| Name | Type | Description |
|---|---|---|
selector |
any |
query selector to filter draft orders |
config |
FindConfig<DraftOrder> |
query config |
Returns
Promise<[DraftOrder[], number]>
draft orders
Defined in
registerCartCompletion
▸ registerCartCompletion(draftOrderId, orderId): Promise<UpdateResult>
Registers a draft order as completed, when an order has been completed.
Parameters
| Name | Type | Description |
|---|---|---|
draftOrderId |
string |
id of draft order to complete |
orderId |
string |
id of order completed from draft order cart |
Returns
Promise<UpdateResult>
the created order
Defined in
retrieve
▸ retrieve(id, config?): Promise<DraftOrder>
Retrieves a draft order with the given id.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the draft order to retrieve |
config |
FindConfig<DraftOrder> |
query object for findOne |
Returns
Promise<DraftOrder>
the draft order
Defined in
retrieveByCartId
▸ retrieveByCartId(cartId, config?): Promise<DraftOrder>
Retrieves a draft order based on its associated cart id
Parameters
| Name | Type | Description |
|---|---|---|
cartId |
string |
cart id that the draft orders's cart has |
config |
FindConfig<DraftOrder> |
query object for findOne |
Returns
Promise<DraftOrder>
the draft order
Defined in
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
interfaces/transaction-base-service.ts:34
update
▸ update(id, data): Promise<DraftOrder>
Updates a draft order with the given data
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the draft order |
data |
Object |
values to update the order with |
data.no_notification_order |
boolean |
- |
Returns
Promise<DraftOrder>
the updated draft order
Defined in
withTransaction
▸ withTransaction(transactionManager?): DraftOrderService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction