@wix/auto_sdk_ecom_orders 1.0.53 → 1.0.54

package/build/internal/index.d.ts

@@ -0,0 +1,395 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { P as Price, a as PreparePaymentCollectionOptions, b as PreparePaymentCollectionResponse, G as GetPaymentCollectabilityStatusResponse, M as MarkOrderAsPaidResponse, B as BulkMarkOrdersAsPaidResponse, c as GetRefundabilityStatusResponse, d as PaymentCollectionCreatePaymentGatewayOrderOptions, C as CreatePaymentGatewayOrderResponse, e as ChargeMembershipsOptions, f as PaymentRefund, T as TriggerRefundOptions, g as TriggerRefundResponse, V as VoidAuthorizedPaymentsResponse, h as PaymentCapture, i as CaptureAuthorizedPaymentsResponse, O as Order, j as OrderSearch, S as SearchOrdersResponse, k as CreateOrderOptions, U as UpdateOrder, l as MaskedOrder, m as BulkUpdateOrdersOptions, n as BulkUpdateOrdersResponse, o as CommitDeltasOptions, p as CommitDeltasResponse, q as UpdateOrderLineItemIdentifiers, r as UpdateOrderLineItem, s as UpdateOrderLineItemResponse, t as PublicActivity, A as AddActivityResponse, u as UpdateActivityIdentifiers, v as UpdateActivityResponse, D as DeleteActivityIdentifiers, w as DeleteActivityResponse, x as CancelOrderOptions, y as CancelOrderResponse, z as OrderStatusWithLiterals, E as UpdateOrderStatusResponse, F as AggregateOrdersOptions, H as AggregateOrdersResponse, I as BulkUpdateOrderTagsOptions, J as BulkUpdateOrderTagsResponse, K as OrderApprovedEnvelope, L as OrderUpdatedEnvelope, N as OrderCanceledEnvelope, Q as OrderCreatedEnvelope } from './ecom-v1-order-orders.universal-DrkwwhMV.js';
+export { dN as ActionEvent, an as ActionType, bF as Activity, bG as ActivityContentOneOf, a9 as ActivityType, gD as AddActivitiesRequest, gE as AddActivitiesResponse, gB as AddActivityRequest, ge as AddInternalActivityRequest, gA as AddInternalActivityResponse, cx as AdditionalFee, fI as AdditionalFeeDelta, fJ as AdditionalFeeDeltaDeltaOneOf, d7 as AdditionalFeeRefund, bh as Address, hu as AddressDescription, bj as AddressLocation, bg as AddressWithContact, _ as AdjustmentType, hb as AggregateOrdersRequest, dw as AggregatedRefundSummary, as as AnimationDetection, ey as App, cT as ApplicationError, bx as AppliedDiscount, fG as AppliedDiscountDelta, fH as AppliedDiscountDeltaDeltaOneOf, by as AppliedDiscountDiscountSourceOneOf, fR as ArchiveOrderRequest, fS as ArchiveOrderResponse, aa as AttributionSource, dl as AuthorizationActionFailureDetails, dk as AuthorizationCapture, ak as AuthorizationCaptureStatus, dj as AuthorizationDetails, dm as AuthorizationVoid, al as AuthorizationVoidStatus, c1 as AuthorizedPaymentCaptured, c0 as AuthorizedPaymentCreated, c2 as AuthorizedPaymentVoided, cw as Balance, cv as BalanceSummary, hX as BaseEventMetadata, fb as BatchOfTriggerReindexOrderRequest, hE as BigDecimalWrapper, b2 as BillingAdjustment, b3 as BillingAdjustmentPriceSummary, cU as BulkActionMetadata, fV as BulkArchiveOrdersByFilterRequest, fW as BulkArchiveOrdersByFilterResponse, fT as BulkArchiveOrdersRequest, fU as BulkArchiveOrdersResponse, gU as BulkMarkAsFulfilledByFilterRequest, gV as BulkMarkAsFulfilledByFilterResponse, gS as BulkMarkAsFulfilledRequest, gT as BulkMarkAsFulfilledResponse, g_ as BulkMarkAsUnfulfilledByFilterRequest, g$ as BulkMarkAsUnfulfilledByFilterResponse, gY as BulkMarkAsUnfulfilledRequest, gZ as BulkMarkAsUnfulfilledResponse, cQ as BulkMarkOrdersAsPaidRequest, cR as BulkOrderResult, dZ as BulkSendBuyerPickupConfirmationEmailsRequest, d_ as BulkSendBuyerPickupConfirmationEmailsResponse, e1 as BulkSendBuyerShippingConfirmationEmailsRequest, e2 as BulkSendBuyerShippingConfirmationEmailsResponse, h0 as BulkSetBusinessLocationRequest, h1 as BulkSetBusinessLocationResponse, h2 as BulkSetBusinessLocationResult, f$ as BulkUnArchiveOrdersByFilterRequest, g0 as BulkUnArchiveOrdersByFilterResponse, fZ as BulkUnArchiveOrdersRequest, f_ as BulkUnArchiveOrdersResponse, hf as BulkUpdateOrderTagsRequest, hg as BulkUpdateOrderTagsResult, fv as BulkUpdateOrdersRequest, bc as BuyerInfo, bd as BuyerInfoIdOneOf, g2 as BuyerInfoUpdate, dA as CalculateRefundItemRequest, dC as CalculateRefundItemResponse, dz as CalculateRefundRequest, dB as CalculateRefundResponse, hO as CalculatedTax, hN as CalculatedTaxes, hm as Cancel, gM as CancelOrderRequest, dE as CaptureAuthorizedPaymentsRequest, aK as CatalogReference, ct as ChannelInfo, ab as ChannelType, c_ as ChargeMembershipsRequest, d2 as ChargeMembershipsResponse, dF as ChargeSavedPaymentMethodRequest, dG as ChargeSavedPaymentMethodResponse, cZ as ChargedBy, aQ as Color, fw as CommitDeltasRequest, fN as CommittedDiffs, fO as CommittedDiffsShippingUpdateInfoOneOf, hx as CommonAddress, hy as CommonAddressStreetOneOf, hw as Company, hl as Complete, fe as ContinueSideEffectsFlowInLegacyData, bz as Coupon, fp as CreateOrderRequest, fs as CreateOrderResponse, cY as CreatePaymentGatewayOrderRequest, cr as CreatedBy, cs as CreatedByStringOneOf, cg as CreditCardDetails, di as CreditCardPaymentMethodDetails, be as CurrencyConversionDetails, eK as CursorPaging, fo as CursorPagingMetadata, fm as CursorSearch, fn as CursorSearchPagingMethodOneOf, eN as Cursors, bH as CustomActivity, cu as CustomField, aE as CustomFieldGroup, hT as CustomFieldValue, hr as Customer, hd as DecrementData, hc as DecrementItemsQuantityRequest, he as DecrementItemsQuantityResponse, cJ as DelayedCaptureSettings, gG as DeleteActivityRequest, f3 as DeleteByFilterOperation, f2 as DeleteByIdsOperation, bn as DeliveryLogistics, bo as DeliveryLogisticsAddressOneOf, br as DeliveryTimeSlot, az as DeltaPaymentOptionType, hV as Deposit, aG as DepositType, aL as DescriptionLine, aN as DescriptionLineDescriptionLineValueOneOf, aO as DescriptionLineName, R as DescriptionLineType, aM as DescriptionLineValueOneOf, fc as DiffmatokyPayload, aY as DigitalFile, hL as Discount, hM as DiscountOneDiscountTypeOneOf, a7 as DiscountReason, bC as DiscountRule, bD as DiscountRuleName, a6 as DiscountType, dH as DomainEvent, dI as DomainEventBodyOneOf, gm as DownloadLinkSent, bN as DraftOrderChangesApplied, fK as DraftOrderCommitSettings, fx as DraftOrderDiffs, fA as DraftOrderDiffsBillingUpdateInfoOneOf, fz as DraftOrderDiffsBuyerUpdateInfoOneOf, fB as DraftOrderDiffsRecipientUpdateInfoOneOf, fy as DraftOrderDiffsShippingUpdateInfoOneOf, cK as Duration, ad as DurationUnit, hs as Email, gv as EmailEdited, dO as Empty, dJ as EntityCreatedEvent, dM as EntityDeletedEvent, dL as EntityUpdatedEvent, fd as ErrorInformation, hY as EventMetadata, b8 as ExtendedFields, co as ExternalReceipt, ds as ExternalReceiptInfo, eC as ExternalUriMapping, aR as FocalPoint, b1 as FreeTrialPeriod, gt as FulfillerEmailSent, a1 as FulfillmentStatus, gR as FulfillmentStatusUpdated, cy as FulfillmentStatusesAggregate, bk as FullAddressContactDetails, ev as GetMetasiteDataRequest, ew as GetMetasiteDataResponse, eW as GetOrderAgcRequest, eX as GetOrderAgcResponse, eO as GetOrderForMetasiteRequest, eP as GetOrderForMetasiteResponse, eU as GetOrderOutOfBoxRequest, eV as GetOrderOutOfBoxResponse, fg as GetOrderRequest, fh as GetOrderResponse, eY as GetOrderWithFilterByLocationRequest, eZ as GetOrderWithFilterByLocationResponse, cL as GetPaymentCollectabilityStatusRequest, cV as GetRefundabilityStatusRequest, h9 as GetShipmentsRequest, ha as GetShipmentsResponse, dp as GiftCardPaymentDetails, c7 as GiftCardPaymentRefund, eB as HtmlApplication, hp as IdAndVersion, dQ as IdentificationData, dR as IdentificationDataIdOneOf, dS as ImageContent, ff as IndexingMessage, gf as InternalActivity, gg as InternalActivityContentOneOf, f0 as InternalDocument, f4 as InternalDocumentUpdateByFilterOperation, f1 as InternalDocumentUpdateOperation, eF as InternalQueryOrdersRequest, fi as InternalQueryOrdersResponse, f5 as InternalUpdateExistingOperation, aA as InventoryAction, fL as InventoryUpdateDetails, gr as InvoiceAdded, hB as InvoiceDates, hS as InvoiceDynamicPriceTotals, hq as InvoiceFields, gs as InvoiceSent, ho as InvoiceSentEvent, aH as InvoiceStatus, hQ as InvoicesPayment, fF as ItemChangedDetails, cS as ItemMetadata, bb as ItemModifier, aV as ItemTaxFullDetails, aT as ItemType, W as ItemTypeItemType, aU as ItemTypeItemTypeDataOneOf, hK as ItemizedFee, Y as JurisdictionType, hD as LineItem, bW as LineItemAmount, bQ as LineItemChanges, fP as LineItemDelta, fQ as LineItemDeltaDeltaOneOf, bE as LineItemDiscount, bM as LineItemExchangeData, hH as LineItemMetaData, bS as LineItemPriceChange, bR as LineItemQuantityChange, a8 as LineItemQuantityChangeType, d6 as LineItemRefund, dy as LineItemRefundSummary, hF as LineItemTax, aX as LineItemTaxBreakdown, aW as LineItemTaxInfo, gI as LineItemUpdate, hC as LineItems, eQ as ListOrderTransactionsForMetasiteRequest, eR as ListOrderTransactionsForMetasiteResponse, hI as Locale, cB as Location, b5 as LocationAndQuantity, bX as ManagedAdditionalFee, bU as ManagedDiscount, bT as ManagedLineItem, ah as ManuallyRefundableReason, gP as MarkAsFulfilledRequest, gQ as MarkAsFulfilledResponse, gW as MarkAsUnfulfilledRequest, gX as MarkAsUnfulfilledResponse, cO as MarkOrderAsPaidRequest, gK as MarkOrderAsSeenByHumanRequest, gL as MarkOrderAsSeenByHumanResponse, gc as MaskedOrderLineItem, c$ as MembershipChargeItem, d0 as MembershipName, dq as MembershipPaymentDetails, c8 as MembershipPaymentRefund, ao as MembershipPaymentStatus, bI as MerchantComment, bA as MerchantDiscount, bB as MerchantDiscountMerchantDiscountReasonOneOf, dP as MessageEnvelope, hR as MetaData, ex as MetaSite, eA as MetaTag, b9 as ModifierGroup, av as Namespace, bL as NewExchangeOrderCreated, ag as NonRefundableReason, ay as OrderApprovalStrategy, cC as OrderApproved, gl as OrderCanceled, gN as OrderCanceledEventOrderCanceled, bO as OrderChange, bP as OrderChangeValueOneOf, fr as OrderCreateNotifications, bK as OrderCreatedFromExchange, fq as OrderCreationSettings, fM as OrderDeltasCommitted, gj as OrderFulfilled, cF as OrderItemsRestocked, aI as OrderLineItem, fE as OrderLineItemChangedDetails, gk as OrderNotFulfilled, gi as OrderPaid, gx as OrderPartiallyPaid, gy as OrderPending, gh as OrderPlaced, bJ as OrderRefunded, gz as OrderRejected, cE as OrderRejectedEventOrderRejected, hZ as OrderSearchSpec, a5 as OrderStatus, bw as OrderTaxBreakdown, bv as OrderTaxInfo, dc as OrderTransactions, cD as OrdersExperiments, dd as Payment, ch as PaymentCanceled, ci as PaymentCanceledPaymentDetailsOneOf, ae as PaymentCollectabilityStatus, cj as PaymentDeclined, ck as PaymentDeclinedPaymentDetailsOneOf, X as PaymentOptionType, de as PaymentPaymentDetailsOneOf, cc as PaymentPending, cd as PaymentPendingPaymentDetailsOneOf, df as PaymentReceiptInfoOneOf, ca as PaymentRefundFailed, c9 as PaymentRefunded, a0 as PaymentStatus, cP as PaymentStatusUpdated, hP as Payments, hv as Phone, aS as PhysicalProperties, bq as PickupAddress, bp as PickupDetails, a4 as PickupMethod, gw as PickupReadyEmailSent, aB as Placement, aP as PlainTextValue, eJ as PlatformPaging, eM as PlatformPagingMetadata, eG as PlatformQuery, eH as PlatformQueryPagingMethodOneOf, cH as PreparePaymentCollectionRequest, el as PreviewBuyerConfirmationEmailRequest, em as PreviewBuyerConfirmationEmailResponse, ej as PreviewBuyerPaymentsReceivedEmailRequest, ek as PreviewBuyerPaymentsReceivedEmailResponse, en as PreviewBuyerPickupConfirmationEmailRequest, eo as PreviewBuyerPickupConfirmationEmailResponse, ef as PreviewCancelEmailRequest, eg as PreviewCancelEmailResponse, eh as PreviewCancelRefundEmailRequest, ei as PreviewCancelRefundEmailResponse, eb as PreviewEmailByTypeRequest, ec as PreviewEmailByTypeResponse, at as PreviewEmailType, ed as PreviewRefundEmailRequest, ee as PreviewRefundEmailResponse, er as PreviewResendDownloadLinksEmailRequest, es as PreviewResendDownloadLinksEmailResponse, ep as PreviewShippingConfirmationEmailRequest, eq as PreviewShippingConfirmationEmailResponse, b4 as PriceDescription, bf as PriceSummary, aJ as ProductName, gC as PublicActivityContentOneOf, fj as QueryOrderRequest, fk as QueryOrderResponse, eE as QueryOrdersForMetasiteRequest, eL as QueryOrdersForMetasiteResponse, ht as QuotesAddress, am as Reason, cl as ReceiptCreated, cm as ReceiptCreatedReceiptInfoOneOf, cp as ReceiptSent, cq as ReceiptSentReceiptInfoOneOf, cM as RecordManuallyCollectedPaymentRequest, cN as RecordManuallyCollectedPaymentResponse, cI as RedirectUrls, dt as Refund, d4 as RefundDetails, c3 as RefundInitiated, d5 as RefundItem, dx as RefundItemsBreakdown, d9 as RefundSideEffects, ap as RefundStatus, dv as RefundStatusInfo, du as RefundTransaction, cW as Refundability, cX as RefundabilityAdditionalRefundabilityInfoOneOf, af as RefundableStatus, cb as RefundedAsStoreCredit, c4 as RefundedPayment, c5 as RefundedPaymentKindOneOf, ce as RegularPayment, dg as RegularPaymentDetails, dh as RegularPaymentDetailsPaymentMethodDetailsOneOf, cf as RegularPaymentPaymentMethodDetailsOneOf, c6 as RegularPaymentRefund, hn as Reschedule, da as RestockInfo, db as RestockItem, ai as RestockType, dK as RestoreInfo, b$ as SavedPaymentMethod, ac as ScheduledAction, fl as SearchOrdersRequest, dT as SendBuyerConfirmationEmailRequest, dU as SendBuyerConfirmationEmailResponse, dV as SendBuyerPaymentsReceivedEmailRequest, dW as SendBuyerPaymentsReceivedEmailResponse, dX as SendBuyerPickupConfirmationEmailRequest, dY as SendBuyerPickupConfirmationEmailResponse, d$ as SendBuyerShippingConfirmationEmailRequest, e0 as SendBuyerShippingConfirmationEmailResponse, e5 as SendCancelRefundEmailRequest, e6 as SendCancelRefundEmailResponse, e3 as SendMerchantOrderReceivedNotificationRequest, e4 as SendMerchantOrderReceivedNotificationResponse, e9 as SendMerchantOrderReceivedPushRequest, ea as SendMerchantOrderReceivedPushResponse, e7 as SendRefundEmailRequest, e8 as SendRefundEmailResponse, ez as SeoData, d1 as ServiceProperties, gu as ShippingAddressEdited, gq as ShippingConfirmationEmailSent, b_ as ShippingInformation, bZ as ShippingInformationChange, bs as ShippingPrice, d8 as ShippingRefund, bt as ShippingRegion, eu as SnapshotMessage, aw as SortOrder, eI as Sorting, hG as Source, aD as SourceType, hA as StandardDetails, au as State, bi as StreetAddress, hz as Subdivision, aC as SubdivisionType, a$ as SubscriptionDescription, Z as SubscriptionFrequency, aZ as SubscriptionInfo, b0 as SubscriptionSettings, a_ as SubscriptionTitle, cA as TagList, cz as Tags, hh as Task, hj as TaskAction, hk as TaskActionActionOneOf, hi as TaskKey, bu as TaxSummary, b6 as TaxableAddress, b7 as TaxableAddressTaxableAddressDataOneOf, $ as TaxableAddressType, ar as TextDetection, hJ as TotalPrice, bY as TotalPriceChange, gp as TrackingLinkAdded, gn as TrackingNumberAdded, go as TrackingNumberEdited, aj as TransactionStatus, ba as TranslatableString, bV as TranslatedValue, d3 as TriggerRefundRequest, et as TriggerReindexOrderRequest, f9 as TriggerReindexRequest, fa as TriggerReindexResponse, hW as TriggerSideEffectsFromLegacyData, fX as UnArchiveOrderRequest, fY as UnArchiveOrderResponse, gF as UpdateActivityRequest, g8 as UpdateBillingContactDetailsRequest, g9 as UpdateBillingContactDetailsResponse, g4 as UpdateBuyerEmailRequest, g5 as UpdateBuyerEmailResponse, g1 as UpdateBuyerInfoRequest, g3 as UpdateBuyerInfoResponse, e_ as UpdateInternalDocumentsEvent, e$ as UpdateInternalDocumentsEventOperationOneOf, gH as UpdateLineItemsDescriptionLinesRequest, gJ as UpdateLineItemsDescriptionLinesResponse, ga as UpdateOrderLineItemRequest, gb as UpdateOrderLineItemsRequest, gd as UpdateOrderLineItemsResponse, ft as UpdateOrderRequest, fu as UpdateOrderResponse, g6 as UpdateOrderShippingAddressRequest, g7 as UpdateOrderShippingAddressResponse, gO as UpdateOrderStatusRequest, eS as UpsertRefundRequest, eT as UpsertRefundResponse, eD as UserDataResponse, h5 as V1BulkMarkOrdersAsPaidRequest, h6 as V1BulkMarkOrdersAsPaidResponse, h7 as V1CreatePaymentGatewayOrderRequest, h8 as V1CreatePaymentGatewayOrderResponse, fC as V1LineItemDelta, fD as V1LineItemDeltaDeltaOneOf, h3 as V1MarkOrderAsPaidRequest, h4 as V1MarkOrderAsPaidResponse, cG as V1RestockItem, dn as V1ScheduledAction, bm as V1ShippingInformation, hU as Value, aF as ValueType, bl as VatId, a3 as VatType, f7 as VersionedDeleteByIdsOperation, f8 as VersionedDocumentId, f6 as VersionedDocumentUpdateOperation, ax as VersioningMode, dD as VoidAuthorizedPaymentsRequest, aq as WebhookIdentityType, a2 as WeightUnit, cn as WixReceipt, dr as WixReceiptInfo } from './ecom-v1-order-orders.universal-DrkwwhMV.js';
+
+declare function preparePaymentCollection$1(httpClient: HttpClient): PreparePaymentCollectionSignature;
+interface PreparePaymentCollectionSignature {
+    /**
+     * Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
+     * Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
+     * 2nd step is an actual charge of prepared payment gateway order. This could be done either
+     * via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
+     * or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
+     * @param - Ecom order ID.
+     * @param - Amount to collect
+     */
+    (ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions | undefined): Promise<PreparePaymentCollectionResponse>;
+}
+declare function getPaymentCollectabilityStatus$1(httpClient: HttpClient): GetPaymentCollectabilityStatusSignature;
+interface GetPaymentCollectabilityStatusSignature {
+    /**
+     * Provides payment collectability status for given order. If payment collection is possible
+     * response will contain collectable amount for given ecom order. If not - response will contain
+     * reason why payment collection is not possible.
+     * @param - Ecom order ID.
+     */
+    (ecomOrderId: string): Promise<GetPaymentCollectabilityStatusResponse>;
+}
+/** @internal */
+declare function recordManuallyCollectedPayment$1(httpClient: HttpClient): RecordManuallyCollectedPaymentSignature;
+interface RecordManuallyCollectedPaymentSignature {
+    /**
+     * Records and approves new manual payment with provided custom amount on given order.
+     * Existing pending payments are ignored.
+     * Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
+     * @param - Order ID.
+     * @param - Amount to be recorded as approved manual payment for given order
+     */
+    (orderId: string, amount: Price): Promise<void>;
+}
+/** @internal */
+declare function paymentCollectionMarkOrderAsPaid$1(httpClient: HttpClient): PaymentCollectionMarkOrderAsPaidSignature;
+interface PaymentCollectionMarkOrderAsPaidSignature {
+    /**
+     * Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
+     * In case the order already has an offline payment transaction associated with it
+     * (usually when manual payment method is chosen at checkout) - This transaction will become approved.
+     * In case the order has no payment transactions associated with it
+     * (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
+     * will be created and approved.
+     * @param - Ecom order ID.
+     */
+    (ecomOrderId: string): Promise<MarkOrderAsPaidResponse>;
+}
+/** @internal */
+declare function paymentCollectionBulkMarkOrdersAsPaid$1(httpClient: HttpClient): PaymentCollectionBulkMarkOrdersAsPaidSignature;
+interface PaymentCollectionBulkMarkOrdersAsPaidSignature {
+    /**
+     * Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
+     * @param - IDs of orders to mark as paid.
+     */
+    (ecomOrderIds: string[]): Promise<BulkMarkOrdersAsPaidResponse>;
+}
+/** @internal */
+declare function getRefundabilityStatus$1(httpClient: HttpClient): GetRefundabilityStatusSignature;
+interface GetRefundabilityStatusSignature {
+    /**
+     * Checks whether this order can be refunded.
+     * @param - Order ID.
+     */
+    (ecomOrderId: string): Promise<GetRefundabilityStatusResponse>;
+}
+/** @internal */
+declare function paymentCollectionCreatePaymentGatewayOrder$1(httpClient: HttpClient): PaymentCollectionCreatePaymentGatewayOrderSignature;
+interface PaymentCollectionCreatePaymentGatewayOrderSignature {
+    /**
+     * Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
+     * 1. An explicit amount provided in the request, or;
+     * 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
+     * As a result, an ID of the created payment gateway order would be returned.
+     * You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
+     * @param - Ecom order ID.
+     */
+    (ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions | undefined): Promise<CreatePaymentGatewayOrderResponse>;
+}
+/** @internal */
+declare function chargeMemberships$1(httpClient: HttpClient): ChargeMembershipsSignature;
+interface ChargeMembershipsSignature {
+    /**
+     * @param - Order ID.
+     * @param - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
+     * but a user which is using the membership on behalf of the a member
+     */
+    (ecomOrderId: string, memberId: string, options?: ChargeMembershipsOptions | undefined): Promise<void>;
+}
+/** @internal */
+declare function triggerRefund$1(httpClient: HttpClient): TriggerRefundSignature;
+interface TriggerRefundSignature {
+    /**
+     * Calls corresponding payment providers and creates refund transactions for requested payments.
+     * Updates order transactions based on refund results.
+     * For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
+     * will only update order transactions.
+     * @param - The order this refund related to
+     * @param - Refund operations information
+     */
+    (ecomOrderId: string, payments: PaymentRefund[], options?: TriggerRefundOptions | undefined): Promise<TriggerRefundResponse>;
+}
+declare function voidAuthorizedPayments$1(httpClient: HttpClient): VoidAuthorizedPaymentsSignature;
+interface VoidAuthorizedPaymentsSignature {
+    /**
+     * Void authorized payments
+     * Transaction statuses for related payments will be updated in async way
+     * @param - Wix eCommerce order ID
+     * @param - Payment IDs
+     */
+    (ecomOrderId: string, paymentIds: string[]): Promise<VoidAuthorizedPaymentsResponse>;
+}
+declare function captureAuthorizedPayments$1(httpClient: HttpClient): CaptureAuthorizedPaymentsSignature;
+interface CaptureAuthorizedPaymentsSignature {
+    /**
+     * Capture authorized payments
+     * Transaction statuses for related payments will be updated in async way
+     * @param - Wix eCommerce order ID
+     * @param - Capture payments information
+     */
+    (ecomOrderId: string, payments: PaymentCapture[]): Promise<CaptureAuthorizedPaymentsResponse>;
+}
+declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
+interface GetOrderSignature {
+    /**
+     * Retrieves an order.
+     *
+     *
+     * The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
+     *
+     * To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
+     * @param - ID of the order to retrieve.
+     * @returns Fulfilled - The requested order.
+     */
+    (_id: string): Promise<Order>;
+}
+declare function searchOrders$1(httpClient: HttpClient): SearchOrdersSignature;
+interface SearchOrdersSignature {
+    /**
+     * Retrieves a list of orders, given the provided paging, filtering, and sorting.
+     *
+     *
+     * Search Orders runs with these defaults, which you can override:
+     *
+     * - `createdDate` is sorted in `DESC` order
+     * - `cursorPaging.limit` is `100`
+     * - `filter: {"status": {"$ne": "INITIALIZED"}}` - other order statuses can be queried, but orders with `status: "INITIALIZED"` are never returned
+     *
+     * For field support for filters and sorting, see [Orders: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/supported-filters-and-sorting).
+     *
+     * To learn about working with _Search_ endpoints, see
+     * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
+     * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
+     * @param - Search options.
+     */
+    (search: OrderSearch): Promise<SearchOrdersResponse>;
+}
+declare function createOrder$1(httpClient: HttpClient): CreateOrderSignature;
+interface CreateOrderSignature {
+    /**
+     * Creates an order.
+     *
+     *
+     * The `createOrder()` function returns a Promise that resolves when the order is created.
+     *
+     * > **Notes:**
+     * > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
+     * > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
+     * @param - Order info.
+     * @returns Newly created order.
+     */
+    (order: Order, options?: CreateOrderOptions | undefined): Promise<Order>;
+}
+declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
+interface UpdateOrderSignature {
+    /**
+     * Updates an order.
+     *
+     *
+     * The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
+     *
+     * Currently, the following fields can be updated:
+     * + `order.buyerInfo.email`
+     * + `order.buyerLanguage`
+     * + `order.weightUnit`
+     * + `order.billingInfo.address`
+     * + `order.billingInfo.contactDetails`
+     * + `order.archived`
+     * + `order.attributionSource`
+     * + `order.seenByAHuman`
+     * + `order.recipientInfo.address`
+     * + `order.recipientInfo.contactDetails`
+     * + `order.shippingInfo.logistics.shippingDestination.address`
+     * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
+     *
+     * To update a field's value, include the new value in the `order` object in the method parameters.
+     * To remove a field's value, pass `null`.
+     *
+     * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
+     *
+     * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
+     * @param - Order ID.
+     * @returns Newly created order.
+     */
+    (_id: string, order: UpdateOrder): Promise<Order>;
+}
+declare function bulkUpdateOrders$1(httpClient: HttpClient): BulkUpdateOrdersSignature;
+interface BulkUpdateOrdersSignature {
+    /**
+     * Updates up to 100 orders.
+     *
+     *
+     * The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
+     *
+     * Currently, the following fields can be updated:
+     * + `order.buyerInfo.email`
+     * + `order.buyerLanguage`
+     * + `order.weightUnit`
+     * + `order.billingInfo.address`
+     * + `order.billingInfo.contactDetails`
+     * + `order.archived`
+     * + `order.attributionSource`
+     * + `order.seenByAHuman`
+     * + `order.recipientInfo.address`
+     * + `order.recipientInfo.contactDetails`
+     * + `order.shippingInfo.logistics.shippingDestination.address`
+     * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
+     *
+     * To update a field's value, include the new value in the `orders.order` object in the method parameters.
+     * To remove a field's value, pass `null`.
+     *
+     * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
+     *
+     * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
+     * @param - Orders to update.
+     */
+    (orders: MaskedOrder[], options?: BulkUpdateOrdersOptions | undefined): Promise<BulkUpdateOrdersResponse>;
+}
+/** @internal */
+declare function commitDeltas$1(httpClient: HttpClient): CommitDeltasSignature;
+interface CommitDeltasSignature {
+    /** @param - Order id to be updated */
+    (_id: string, options?: CommitDeltasOptions | undefined): Promise<CommitDeltasResponse>;
+}
+/** @internal */
+declare function updateOrderLineItem$1(httpClient: HttpClient): UpdateOrderLineItemSignature;
+interface UpdateOrderLineItemSignature {
+    /** @deprecated */
+    (identifiers: UpdateOrderLineItemIdentifiers, lineItem: UpdateOrderLineItem): Promise<UpdateOrderLineItemResponse>;
+}
+/** @internal */
+declare function addActivity$1(httpClient: HttpClient): AddActivitySignature;
+interface AddActivitySignature {
+    /**
+     * Adds a merchant comment to an order.
+     * > **Note:** Activities with type CustomActivity not supported
+     * @param - Order ID.
+     * @param - Activity info.
+     * @deprecated
+     */
+    (_id: string, activity: PublicActivity): Promise<AddActivityResponse>;
+}
+/** @internal */
+declare function updateActivity$1(httpClient: HttpClient): UpdateActivitySignature;
+interface UpdateActivitySignature {
+    /**
+     * Updates an order's activity.
+     * @param - Activity info.
+     */
+    (identifiers: UpdateActivityIdentifiers, activity: PublicActivity): Promise<UpdateActivityResponse>;
+}
+/** @internal */
+declare function deleteActivity$1(httpClient: HttpClient): DeleteActivitySignature;
+interface DeleteActivitySignature {
+    /**
+     * Delete's an order's activity.
+     *
+     * Only custom activities and merchant comments can be deleted.
+     */
+    (identifiers: DeleteActivityIdentifiers): Promise<DeleteActivityResponse>;
+}
+declare function cancelOrder$1(httpClient: HttpClient): CancelOrderSignature;
+interface CancelOrderSignature {
+    /**
+     * Cancels an order.
+     *
+     *
+     * The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
+     * @param - Order ID.
+     */
+    (_id: string, options?: CancelOrderOptions | undefined): Promise<CancelOrderResponse>;
+}
+/** @internal */
+declare function updateOrderStatus$1(httpClient: HttpClient): UpdateOrderStatusSignature;
+interface UpdateOrderStatusSignature {
+    /**
+     * Updates order status.
+     *
+     * >CANCELED and REJECTED are final statuses. Update from either of those will fail.
+     * >Updates into INITIALIZED are not supported.
+     *
+     * Approving order:
+     * APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
+     *
+     * Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
+     * will cause an error.
+     *
+     * Setting PENDING status:
+     * Only orders in INITIALIZED status can be updated into PENDING.
+     * @param - Order ID.
+     * @param - New order status.
+     */
+    (orderId: string, status: OrderStatusWithLiterals): Promise<UpdateOrderStatusResponse>;
+}
+/** @internal */
+declare function aggregateOrders$1(httpClient: HttpClient): AggregateOrdersSignature;
+interface AggregateOrdersSignature {
+    /** */
+    (options?: AggregateOrdersOptions | undefined): Promise<AggregateOrdersResponse>;
+}
+declare function bulkUpdateOrderTags$1(httpClient: HttpClient): BulkUpdateOrderTagsSignature;
+interface BulkUpdateOrderTagsSignature {
+    /**
+     * Synchronously update tags on multiple orders, by list of order IDs.
+     *
+     * > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
+     * @param - IDs of orders to update tags for.
+     */
+    (orderIds: string[], options?: BulkUpdateOrderTagsOptions | undefined): Promise<BulkUpdateOrderTagsResponse>;
+}
+declare const onOrderApproved$1: EventDefinition<OrderApprovedEnvelope, "wix.ecom.v1.order_approved">;
+declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.ecom.v1.order_updated">;
+declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.ecom.v1.order_canceled">;
+declare const onOrderCreated$1: EventDefinition<OrderCreatedEnvelope, "wix.ecom.v1.order_created">;
+
+declare const preparePaymentCollection: MaybeContext<BuildRESTFunction<typeof preparePaymentCollection$1> & typeof preparePaymentCollection$1>;
+declare const getPaymentCollectabilityStatus: MaybeContext<BuildRESTFunction<typeof getPaymentCollectabilityStatus$1> & typeof getPaymentCollectabilityStatus$1>;
+/** @internal */
+declare const recordManuallyCollectedPayment: MaybeContext<BuildRESTFunction<typeof recordManuallyCollectedPayment$1> & typeof recordManuallyCollectedPayment$1>;
+/** @internal */
+declare const paymentCollectionMarkOrderAsPaid: MaybeContext<BuildRESTFunction<typeof paymentCollectionMarkOrderAsPaid$1> & typeof paymentCollectionMarkOrderAsPaid$1>;
+/** @internal */
+declare const paymentCollectionBulkMarkOrdersAsPaid: MaybeContext<BuildRESTFunction<typeof paymentCollectionBulkMarkOrdersAsPaid$1> & typeof paymentCollectionBulkMarkOrdersAsPaid$1>;
+/** @internal */
+declare const getRefundabilityStatus: MaybeContext<BuildRESTFunction<typeof getRefundabilityStatus$1> & typeof getRefundabilityStatus$1>;
+/** @internal */
+declare const paymentCollectionCreatePaymentGatewayOrder: MaybeContext<BuildRESTFunction<typeof paymentCollectionCreatePaymentGatewayOrder$1> & typeof paymentCollectionCreatePaymentGatewayOrder$1>;
+/** @internal */
+declare const chargeMemberships: MaybeContext<BuildRESTFunction<typeof chargeMemberships$1> & typeof chargeMemberships$1>;
+/** @internal */
+declare const triggerRefund: MaybeContext<BuildRESTFunction<typeof triggerRefund$1> & typeof triggerRefund$1>;
+declare const voidAuthorizedPayments: MaybeContext<BuildRESTFunction<typeof voidAuthorizedPayments$1> & typeof voidAuthorizedPayments$1>;
+declare const captureAuthorizedPayments: MaybeContext<BuildRESTFunction<typeof captureAuthorizedPayments$1> & typeof captureAuthorizedPayments$1>;
+declare const getOrder: MaybeContext<BuildRESTFunction<typeof getOrder$1> & typeof getOrder$1>;
+declare const searchOrders: MaybeContext<BuildRESTFunction<typeof searchOrders$1> & typeof searchOrders$1>;
+declare const createOrder: MaybeContext<BuildRESTFunction<typeof createOrder$1> & typeof createOrder$1>;
+declare const updateOrder: MaybeContext<BuildRESTFunction<typeof updateOrder$1> & typeof updateOrder$1>;
+declare const bulkUpdateOrders: MaybeContext<BuildRESTFunction<typeof bulkUpdateOrders$1> & typeof bulkUpdateOrders$1>;
+/** @internal */
+declare const commitDeltas: MaybeContext<BuildRESTFunction<typeof commitDeltas$1> & typeof commitDeltas$1>;
+/** @internal */
+declare const updateOrderLineItem: MaybeContext<BuildRESTFunction<typeof updateOrderLineItem$1> & typeof updateOrderLineItem$1>;
+/** @internal */
+declare const addActivity: MaybeContext<BuildRESTFunction<typeof addActivity$1> & typeof addActivity$1>;
+/** @internal */
+declare const updateActivity: MaybeContext<BuildRESTFunction<typeof updateActivity$1> & typeof updateActivity$1>;
+/** @internal */
+declare const deleteActivity: MaybeContext<BuildRESTFunction<typeof deleteActivity$1> & typeof deleteActivity$1>;
+declare const cancelOrder: MaybeContext<BuildRESTFunction<typeof cancelOrder$1> & typeof cancelOrder$1>;
+/** @internal */
+declare const updateOrderStatus: MaybeContext<BuildRESTFunction<typeof updateOrderStatus$1> & typeof updateOrderStatus$1>;
+/** @internal */
+declare const aggregateOrders: MaybeContext<BuildRESTFunction<typeof aggregateOrders$1> & typeof aggregateOrders$1>;
+declare const bulkUpdateOrderTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateOrderTags$1> & typeof bulkUpdateOrderTags$1>;
+/** */
+declare const onOrderApproved: BuildEventDefinition<typeof onOrderApproved$1>;
+/** */
+declare const onOrderUpdated: BuildEventDefinition<typeof onOrderUpdated$1>;
+/**
+ * Triggered when an order is canceled.
+ * Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
+ */
+declare const onOrderCanceled: BuildEventDefinition<typeof onOrderCanceled$1>;
+/**
+ * Triggered when an order is created.
+ * Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
+ */
+declare const onOrderCreated: BuildEventDefinition<typeof onOrderCreated$1>;
+
+export { AddActivityResponse, AggregateOrdersOptions, AggregateOrdersResponse, BulkMarkOrdersAsPaidResponse, BulkUpdateOrderTagsOptions, BulkUpdateOrderTagsResponse, BulkUpdateOrdersOptions, BulkUpdateOrdersResponse, CancelOrderOptions, CancelOrderResponse, CaptureAuthorizedPaymentsResponse, ChargeMembershipsOptions, CommitDeltasOptions, CommitDeltasResponse, CreateOrderOptions, CreatePaymentGatewayOrderResponse, DeleteActivityIdentifiers, DeleteActivityResponse, GetPaymentCollectabilityStatusResponse, GetRefundabilityStatusResponse, MarkOrderAsPaidResponse, MaskedOrder, Order, OrderApprovedEnvelope, OrderCanceledEnvelope, OrderCreatedEnvelope, OrderUpdatedEnvelope, PaymentCapture, PaymentCollectionCreatePaymentGatewayOrderOptions, PaymentRefund, PreparePaymentCollectionOptions, PreparePaymentCollectionResponse, Price, PublicActivity, SearchOrdersResponse, TriggerRefundOptions, TriggerRefundResponse, UpdateActivityIdentifiers, UpdateActivityResponse, UpdateOrder, UpdateOrderLineItem, UpdateOrderLineItemIdentifiers, UpdateOrderLineItemResponse, UpdateOrderStatusResponse, VoidAuthorizedPaymentsResponse, addActivity, aggregateOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, commitDeltas, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, onOrderApproved, onOrderCanceled, onOrderCreated, onOrderUpdated, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };