@wix/auto_sdk_ecom_orders 1.0.62 → 1.0.63
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +26 -19
- package/build/cjs/index.js.map +1 -1
- package/build/es/index.d.mts +26 -19
- package/build/es/index.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +61 -38
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/es/index.d.mts +61 -38
- package/build/internal/es/index.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/index.d.mts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
1
|
+
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
2
|
import { P as Price, a as PreparePaymentCollectionOptions, b as PreparePaymentCollectionResponse, c as PreparePaymentCollectionApplicationErrors, G as GetPaymentCollectabilityStatusResponse, V as VoidAuthorizedPaymentsResponse, d as VoidAuthorizedPaymentsApplicationErrors, e as PaymentCapture, C as CaptureAuthorizedPaymentsResponse, f as CaptureAuthorizedPaymentsApplicationErrors, O as Order, g as GetOrderApplicationErrors, h as OrderSearch, S as SearchOrdersResponse, i as CreateOrderOptions, j as CreateOrderApplicationErrors, U as UpdateOrder, k as UpdateOrderApplicationErrors, M as MaskedOrder, B as BulkUpdateOrdersOptions, l as BulkUpdateOrdersResponse, m as CancelOrderOptions, n as CancelOrderResponse, o as CancelOrderApplicationErrors, p as BulkUpdateOrderTagsOptions, q as BulkUpdateOrderTagsResponse, r as OrderApprovedEnvelope, s as OrderUpdatedEnvelope, t as OrderCanceledEnvelope, u as OrderCreatedEnvelope } from './ecom-v1-order-orders.universal-CaDvypy_.mjs';
|
|
3
3
|
export { dF as ActionEvent, a6 as ActionType, bp as Activity, bq as ActivityContentOneOf, N as ActivityType, gC as AddActivitiesRequest, gD as AddActivitiesResponse, gy as AddActivityRequest, gB as AddActivityResponse, gb as AddInternalActivityRequest, gx as AddInternalActivityResponse, cj as AdditionalFee, fD as AdditionalFeeDelta, fE as AdditionalFeeDeltaDeltaOneOf, cZ as AdditionalFeeRefund, b1 as Address, hx as AddressDescription, b3 as AddressLocation, b0 as AddressWithContact, A as AdjustmentType, i9 as AggregateOrdersOptions, hd as AggregateOrdersRequest, he as AggregateOrdersResponse, dn as AggregatedRefundSummary, ac as AnimationDetection, er as App, cG as ApplicationError, bh as AppliedDiscount, fB as AppliedDiscountDelta, fC as AppliedDiscountDeltaDeltaOneOf, bi as AppliedDiscountDiscountSourceOneOf, fN as ArchiveOrderRequest, fO as ArchiveOrderResponse, Q as AttributionSource, dc as AuthorizationActionFailureDetails, db as AuthorizationCapture, a3 as AuthorizationCaptureStatus, da as AuthorizationDetails, dd as AuthorizationVoid, a4 as AuthorizationVoidStatus, bN as AuthorizedPaymentCaptured, bM as AuthorizedPaymentCreated, bO as AuthorizedPaymentVoided, ci as Balance, ch as BalanceSummary, h_ as BaseEventMetadata, f6 as BatchOfTriggerReindexOrderRequest, hH as BigDecimalWrapper, aO as BillingAdjustment, aP as BillingAdjustmentPriceSummary, cH as BulkActionMetadata, fR as BulkArchiveOrdersByFilterRequest, fS as BulkArchiveOrdersByFilterResponse, fP as BulkArchiveOrdersRequest, fQ as BulkArchiveOrdersResponse, gW as BulkMarkAsFulfilledByFilterRequest, gX as BulkMarkAsFulfilledByFilterResponse, gU as BulkMarkAsFulfilledRequest, gV as BulkMarkAsFulfilledResponse, h0 as BulkMarkAsUnfulfilledByFilterRequest, h1 as BulkMarkAsUnfulfilledByFilterResponse, g_ as BulkMarkAsUnfulfilledRequest, g$ as BulkMarkAsUnfulfilledResponse, cC as BulkMarkOrdersAsPaidRequest, cD as BulkMarkOrdersAsPaidResponse, cE as BulkOrderResult, dR as BulkSendBuyerPickupConfirmationEmailsRequest, dS as BulkSendBuyerPickupConfirmationEmailsResponse, dV as BulkSendBuyerShippingConfirmationEmailsRequest, dW as BulkSendBuyerShippingConfirmationEmailsResponse, h2 as BulkSetBusinessLocationRequest, h3 as BulkSetBusinessLocationResponse, h4 as BulkSetBusinessLocationResult, fX as BulkUnArchiveOrdersByFilterRequest, fY as BulkUnArchiveOrdersByFilterResponse, fV as BulkUnArchiveOrdersRequest, fW as BulkUnArchiveOrdersResponse, hi as BulkUpdateOrderTagsRequest, hj as BulkUpdateOrderTagsResult, fq as BulkUpdateOrdersRequest, aY as BuyerInfo, aZ as BuyerInfoIdOneOf, f_ as BuyerInfoUpdate, ds as CalculateRefundItemRequest, du as CalculateRefundItemResponse, dr as CalculateRefundRequest, dt as CalculateRefundResponse, hR as CalculatedTax, hQ as CalculatedTaxes, hp as Cancel, gN as CancelOrderRequest, dw as CaptureAuthorizedPaymentsRequest, au as CatalogReference, cf as ChannelInfo, R as ChannelType, i1 as ChargeMembershipsOptions, cP as ChargeMembershipsRequest, cT as ChargeMembershipsResponse, dx as ChargeSavedPaymentMethodRequest, dy as ChargeSavedPaymentMethodResponse, df as Chargeback, cb as ChargebackCreated, cc as ChargebackReversed, a7 as ChargebackStatus, cN as ChargedBy, aA as Color, i4 as CommitDeltasOptions, fr as CommitDeltasRequest, fH as CommitDeltasResponse, fJ as CommittedDiffs, fK as CommittedDiffsShippingUpdateInfoOneOf, hA as CommonAddress, hB as CommonAddressStreetOneOf, hz as Company, ho as Complete, f9 as ContinueSideEffectsFlowInLegacyData, bj as Coupon, fk as CreateOrderRequest, fn as CreateOrderResponse, cM as CreatePaymentGatewayOrderRequest, cO as CreatePaymentGatewayOrderResponse, cd as CreatedBy, ce as CreatedByStringOneOf, c0 as CreditCardDetails, d9 as CreditCardPaymentMethodDetails, a_ as CurrencyConversionDetails, eD as CursorPaging, fj as CursorPagingMetadata, fh as CursorSearch, fi as CursorSearchPagingMethodOneOf, eG as Cursors, br as CustomActivity, cg as CustomField, ao as CustomFieldGroup, hW as CustomFieldValue, hu as Customer, hg as DecrementData, hf as DecrementItemsQuantityRequest, hh as DecrementItemsQuantityResponse, cv as DelayedCaptureSettings, i8 as DeleteActivityIdentifiers, gG as DeleteActivityRequest, gH as DeleteActivityResponse, e_ as DeleteByFilterOperation, eZ as DeleteByIdsOperation, b7 as DeliveryLogistics, b8 as DeliveryLogisticsAddressOneOf, bb as DeliveryTimeSlot, aj as DeltaPaymentOptionType, hY as Deposit, aq as DepositType, av as DescriptionLine, ax as DescriptionLineDescriptionLineValueOneOf, ay as DescriptionLineName, D as DescriptionLineType, aw as DescriptionLineValueOneOf, f7 as DiffmatokyPayload, aI as DigitalFile, hO as Discount, hP as DiscountOneDiscountTypeOneOf, K as DiscountReason, bm as DiscountRule, bn as DiscountRuleName, H as DiscountType, dz as DomainEvent, dA as DomainEventBodyOneOf, gj as DownloadLinkSent, bx as DraftOrderChangesApplied, fF as DraftOrderCommitSettings, fs as DraftOrderDiffs, fv as DraftOrderDiffsBillingUpdateInfoOneOf, fu as DraftOrderDiffsBuyerUpdateInfoOneOf, fw as DraftOrderDiffsRecipientUpdateInfoOneOf, ft as DraftOrderDiffsShippingUpdateInfoOneOf, cw as Duration, Y as DurationUnit, hv as Email, gs as EmailEdited, dG as Empty, dB as EntityCreatedEvent, dE as EntityDeletedEvent, dD as EntityUpdatedEvent, f8 as ErrorInformation, h$ as EventMetadata, aU as ExtendedFields, c8 as ExternalReceipt, dj as ExternalReceiptInfo, ev as ExternalUriMapping, aB as FocalPoint, aN as FreeTrialPeriod, gq as FulfillerEmailSent, F as FulfillmentStatus, gT as FulfillmentStatusUpdated, ck as FulfillmentStatusesAggregate, b4 as FullAddressContactDetails, eo as GetMetasiteDataRequest, ep as GetMetasiteDataResponse, eP as GetOrderAgcRequest, eQ as GetOrderAgcResponse, eH as GetOrderForMetasiteRequest, eI as GetOrderForMetasiteResponse, eN as GetOrderOutOfBoxRequest, eO as GetOrderOutOfBoxResponse, fb as GetOrderRequest, fc as GetOrderResponse, eR as GetOrderWithFilterByLocationRequest, eS as GetOrderWithFilterByLocationResponse, cx as GetPaymentCollectabilityStatusRequest, cI as GetRefundabilityStatusRequest, cJ as GetRefundabilityStatusResponse, hb as GetShipmentsRequest, hc as GetShipmentsResponse, dg as GiftCardPaymentDetails, bT as GiftCardPaymentRefund, eu as HtmlApplication, hs as IdAndVersion, dI as IdentificationData, dJ as IdentificationDataIdOneOf, dK as ImageContent, fa as IndexingMessage, gc as InternalActivity, gd as InternalActivityContentOneOf, eX as InternalDocument, e$ as InternalDocumentUpdateByFilterOperation, eY as InternalDocumentUpdateOperation, ey as InternalQueryOrdersRequest, fd as InternalQueryOrdersResponse, f0 as InternalUpdateExistingOperation, ak as InventoryAction, fG as InventoryUpdateDetails, go as InvoiceAdded, hE as InvoiceDates, hV as InvoiceDynamicPriceTotals, ht as InvoiceFields, gp as InvoiceSent, hr as InvoiceSentEvent, ar as InvoiceStatus, hT as InvoicesPayment, fA as ItemChangedDetails, cF as ItemMetadata, aX as ItemModifier, aF as ItemTaxFullDetails, aD as ItemType, I as ItemTypeItemType, aE as ItemTypeItemTypeDataOneOf, hN as ItemizedFee, J as JurisdictionType, hG as LineItem, bG as LineItemAmount, bA as LineItemChanges, fL as LineItemDelta, fM as LineItemDeltaDeltaOneOf, bo as LineItemDiscount, bw as LineItemExchangeData, hK as LineItemMetaData, bC as LineItemPriceChange, bB as LineItemQuantityChange, L as LineItemQuantityChangeType, cY as LineItemRefund, dq as LineItemRefundSummary, hI as LineItemTax, aH as LineItemTaxBreakdown, aG as LineItemTaxInfo, gJ as LineItemUpdate, hF as LineItems, eJ as ListOrderTransactionsForMetasiteRequest, eK as ListOrderTransactionsForMetasiteResponse, hL as Locale, cn as Location, aR as LocationAndQuantity, bH as ManagedAdditionalFee, bE as ManagedDiscount, bD as ManagedLineItem, a0 as ManuallyRefundableReason, gR as MarkAsFulfilledRequest, gS as MarkAsFulfilledResponse, gY as MarkAsUnfulfilledRequest, gZ as MarkAsUnfulfilledResponse, cA as MarkOrderAsPaidRequest, cB as MarkOrderAsPaidResponse, gL as MarkOrderAsSeenByHumanRequest, gM as MarkOrderAsSeenByHumanResponse, g9 as MaskedOrderLineItem, cQ as MembershipChargeItem, cR as MembershipName, dh as MembershipPaymentDetails, bU as MembershipPaymentRefund, a8 as MembershipPaymentStatus, bs as MerchantComment, bk as MerchantDiscount, bl as MerchantDiscountMerchantDiscountReasonOneOf, dH as MessageEnvelope, hU as MetaData, eq as MetaSite, et as MetaTag, aV as ModifierGroup, af as Namespace, bv as NewExchangeOrderCreated, $ as NonRefundableReason, ai as OrderApprovalStrategy, co as OrderApproved, gi as OrderCanceled, gO as OrderCanceledEventOrderCanceled, by as OrderChange, bz as OrderChangeValueOneOf, fm as OrderCreateNotifications, bu as OrderCreatedFromExchange, fl as OrderCreationSettings, fI as OrderDeltasCommitted, gg as OrderFulfilled, cr as OrderItemsRestocked, as as OrderLineItem, fz as OrderLineItemChangedDetails, gh as OrderNotFulfilled, gf as OrderPaid, gu as OrderPartiallyPaid, gv as OrderPending, ge as OrderPlaced, bt as OrderRefunded, gw as OrderRejected, cq as OrderRejectedEventOrderRejected, i3 as OrderSearchSpec, E as OrderStatus, bg as OrderTaxBreakdown, bf as OrderTaxInfo, d3 as OrderTransactions, cp as OrdersExperiments, d4 as Payment, c1 as PaymentCanceled, c2 as PaymentCanceledPaymentDetailsOneOf, Z as PaymentCollectabilityStatus, i0 as PaymentCollectionCreatePaymentGatewayOrderOptions, c3 as PaymentDeclined, c4 as PaymentDeclinedPaymentDetailsOneOf, v as PaymentOptionType, d5 as PaymentPaymentDetailsOneOf, bY as PaymentPending, bZ as PaymentPendingPaymentDetailsOneOf, d6 as PaymentReceiptInfoOneOf, cV as PaymentRefund, bW as PaymentRefundFailed, bV as PaymentRefunded, x as PaymentStatus, en as PaymentStatusUpdated, hS as Payments, hy as Phone, aC as PhysicalProperties, ba as PickupAddress, b9 as PickupDetails, z as PickupMethod, gt as PickupReadyEmailSent, al as Placement, az as PlainTextValue, eC as PlatformPaging, eF as PlatformPagingMetadata, ez as PlatformQuery, eA as PlatformQueryPagingMethodOneOf, ct as PreparePaymentCollectionRequest, ed as PreviewBuyerConfirmationEmailRequest, ee as PreviewBuyerConfirmationEmailResponse, eb as PreviewBuyerPaymentsReceivedEmailRequest, ec as PreviewBuyerPaymentsReceivedEmailResponse, ef as PreviewBuyerPickupConfirmationEmailRequest, eg as PreviewBuyerPickupConfirmationEmailResponse, e7 as PreviewCancelEmailRequest, e8 as PreviewCancelEmailResponse, e9 as PreviewCancelRefundEmailRequest, ea as PreviewCancelRefundEmailResponse, e3 as PreviewEmailByTypeRequest, e4 as PreviewEmailByTypeResponse, ad as PreviewEmailType, e5 as PreviewRefundEmailRequest, e6 as PreviewRefundEmailResponse, ej as PreviewResendDownloadLinksEmailRequest, ek as PreviewResendDownloadLinksEmailResponse, eh as PreviewShippingConfirmationEmailRequest, ei as PreviewShippingConfirmationEmailResponse, aQ as PriceDescription, a$ as PriceSummary, at as ProductName, gz as PublicActivity, gA as PublicActivityContentOneOf, fe as QueryOrderRequest, ff as QueryOrderResponse, ex as QueryOrdersForMetasiteRequest, eE as QueryOrdersForMetasiteResponse, hw as QuotesAddress, a5 as Reason, c5 as ReceiptCreated, c6 as ReceiptCreatedReceiptInfoOneOf, c9 as ReceiptSent, ca as ReceiptSentReceiptInfoOneOf, cy as RecordManuallyCollectedPaymentRequest, cz as RecordManuallyCollectedPaymentResponse, cu as RedirectUrls, dk as Refund, cW as RefundDetails, bP as RefundInitiated, cX as RefundItem, dp as RefundItemsBreakdown, c$ as RefundSideEffects, a9 as RefundStatus, dm as RefundStatusInfo, dl as RefundTransaction, cK as Refundability, cL as RefundabilityAdditionalRefundabilityInfoOneOf, _ as RefundableStatus, bX as RefundedAsStoreCredit, bQ as RefundedPayment, bR as RefundedPaymentKindOneOf, b_ as RegularPayment, d7 as RegularPaymentDetails, d8 as RegularPaymentDetailsPaymentMethodDetailsOneOf, b$ as RegularPaymentPaymentMethodDetailsOneOf, bS as RegularPaymentRefund, hq as Reschedule, d0 as RestockInfo, d1 as RestockItem, a1 as RestockType, dC as RestoreInfo, bL as SavedPaymentMethod, X as ScheduledAction, fg as SearchOrdersRequest, dL as SendBuyerConfirmationEmailRequest, dM as SendBuyerConfirmationEmailResponse, dN as SendBuyerPaymentsReceivedEmailRequest, dO as SendBuyerPaymentsReceivedEmailResponse, dP as SendBuyerPickupConfirmationEmailRequest, dQ as SendBuyerPickupConfirmationEmailResponse, dT as SendBuyerShippingConfirmationEmailRequest, dU as SendBuyerShippingConfirmationEmailResponse, dZ as SendCancelRefundEmailRequest, d_ as SendCancelRefundEmailResponse, dX as SendMerchantOrderReceivedNotificationRequest, dY as SendMerchantOrderReceivedNotificationResponse, e1 as SendMerchantOrderReceivedPushRequest, e2 as SendMerchantOrderReceivedPushResponse, d$ as SendRefundEmailRequest, e0 as SendRefundEmailResponse, es as SeoData, cS as ServiceProperties, gr as ShippingAddressEdited, gn as ShippingConfirmationEmailSent, bK as ShippingInformation, bJ as ShippingInformationChange, bc as ShippingPrice, c_ as ShippingRefund, bd as ShippingRegion, em as SnapshotMessage, ag as SortOrder, eB as Sorting, hJ as Source, an as SourceType, hD as StandardDetails, ae as State, b2 as StreetAddress, hC as Subdivision, am as SubdivisionType, aL as SubscriptionDescription, w as SubscriptionFrequency, aJ as SubscriptionInfo, aM as SubscriptionSettings, aK as SubscriptionTitle, cm as TagList, cl as Tags, hk as Task, hm as TaskAction, hn as TaskActionActionOneOf, hl as TaskKey, be as TaxSummary, aS as TaxableAddress, aT as TaxableAddressTaxableAddressDataOneOf, T as TaxableAddressType, ab as TextDetection, hM as TotalPrice, bI as TotalPriceChange, gm as TrackingLinkAdded, gk as TrackingNumberAdded, gl as TrackingNumberEdited, a2 as TransactionStatus, aW as TranslatableString, bF as TranslatedValue, i2 as TriggerRefundOptions, cU as TriggerRefundRequest, d2 as TriggerRefundResponse, el as TriggerReindexOrderRequest, f4 as TriggerReindexRequest, f5 as TriggerReindexResponse, hZ as TriggerSideEffectsFromLegacyData, fT as UnArchiveOrderRequest, fU as UnArchiveOrderResponse, i7 as UpdateActivityIdentifiers, gE as UpdateActivityRequest, gF as UpdateActivityResponse, g4 as UpdateBillingContactDetailsRequest, g5 as UpdateBillingContactDetailsResponse, g0 as UpdateBuyerEmailRequest, g1 as UpdateBuyerEmailResponse, fZ as UpdateBuyerInfoRequest, f$ as UpdateBuyerInfoResponse, eV as UpdateInternalDocumentsEvent, eW as UpdateInternalDocumentsEventOperationOneOf, gI as UpdateLineItemsDescriptionLinesRequest, gK as UpdateLineItemsDescriptionLinesResponse, i6 as UpdateOrderLineItem, i5 as UpdateOrderLineItemIdentifiers, g6 as UpdateOrderLineItemRequest, g7 as UpdateOrderLineItemResponse, g8 as UpdateOrderLineItemsRequest, ga as UpdateOrderLineItemsResponse, fo as UpdateOrderRequest, fp as UpdateOrderResponse, g2 as UpdateOrderShippingAddressRequest, g3 as UpdateOrderShippingAddressResponse, gP as UpdateOrderStatusRequest, gQ as UpdateOrderStatusResponse, eL as UpsertRefundRequest, eM as UpsertRefundResponse, ew as UserDataResponse, h7 as V1BulkMarkOrdersAsPaidRequest, h8 as V1BulkMarkOrdersAsPaidResponse, h9 as V1CreatePaymentGatewayOrderRequest, ha as V1CreatePaymentGatewayOrderResponse, fx as V1LineItemDelta, fy as V1LineItemDeltaDeltaOneOf, h5 as V1MarkOrderAsPaidRequest, h6 as V1MarkOrderAsPaidResponse, cs as V1RestockItem, de as V1ScheduledAction, b6 as V1ShippingInformation, eT as V1UpdateOrderRequest, eU as V1UpdateOrderResponse, hX as Value, ap as ValueType, b5 as VatId, y as VatType, f2 as VersionedDeleteByIdsOperation, f3 as VersionedDocumentId, f1 as VersionedDocumentUpdateOperation, ah as VersioningMode, dv as VoidAuthorizedPaymentsRequest, aa as WebhookIdentityType, W as WeightUnit, c7 as WixReceipt, di as WixReceiptInfo } from './ecom-v1-order-orders.universal-CaDvypy_.mjs';
|
|
4
4
|
|
|
5
|
+
type OrderNonNullablePaths = `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `priceSummary.subtotal.amount` | `priceSummary.subtotal.formattedAmount` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.shippingDestination.address.streetAddress.number` | `shippingInfo.logistics.shippingDestination.address.streetAddress.name` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId._id` | `shippingInfo.logistics.shippingDestination.contactDetails.vatId.type` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `shippingInfo.cost.price.amount` | `shippingInfo.cost.price.formattedAmount` | `shippingInfo.cost.taxDetails.taxRate` | `status` | `taxSummary.totalTax.amount` | `taxSummary.totalTax.formattedAmount` | `taxInfo.totalTax.amount` | `taxInfo.totalTax.formattedAmount` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.coupon.amount.amount` | `appliedDiscounts.${number}.coupon.amount.formattedAmount` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.customActivity.appId` | `activities.${number}.customActivity.type` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.amount.amount` | `activities.${number}.orderRefunded.amount.formattedAmount` | `activities.${number}.orderRefunded.reason` | `activities.${number}.type` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.paid.amount` | `balanceSummary.paid.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}.price.amount` | `additionalFees.${number}.price.formattedAmount` | `additionalFees.${number}.taxDetails.taxRate` | `additionalFees.${number}._id` | `recipientInfo.address.streetAddress.number` | `recipientInfo.address.streetAddress.name` | `recipientInfo.contactDetails.vatId._id` | `recipientInfo.contactDetails.vatId.type` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `payAfterFreeTrial.subtotal.amount` | `payAfterFreeTrial.subtotal.formattedAmount`;
|
|
5
6
|
declare function preparePaymentCollection$1(httpClient: HttpClient): PreparePaymentCollectionSignature;
|
|
6
7
|
interface PreparePaymentCollectionSignature {
|
|
7
8
|
/**
|
|
@@ -13,8 +14,8 @@ interface PreparePaymentCollectionSignature {
|
|
|
13
14
|
* @param - Ecom order ID.
|
|
14
15
|
* @param - Amount to collect
|
|
15
16
|
*/
|
|
16
|
-
(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions
|
|
17
|
-
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors
|
|
17
|
+
(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`> & {
|
|
18
|
+
__applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
|
|
18
19
|
}>;
|
|
19
20
|
}
|
|
20
21
|
declare function getPaymentCollectabilityStatus$1(httpClient: HttpClient): GetPaymentCollectabilityStatusSignature;
|
|
@@ -25,7 +26,7 @@ interface GetPaymentCollectabilityStatusSignature {
|
|
|
25
26
|
* reason why payment collection is not possible.
|
|
26
27
|
* @param - Ecom order ID.
|
|
27
28
|
*/
|
|
28
|
-
(ecomOrderId: string): Promise<GetPaymentCollectabilityStatusResponse
|
|
29
|
+
(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`>>;
|
|
29
30
|
}
|
|
30
31
|
declare function voidAuthorizedPayments$1(httpClient: HttpClient): VoidAuthorizedPaymentsSignature;
|
|
31
32
|
interface VoidAuthorizedPaymentsSignature {
|
|
@@ -35,8 +36,8 @@ interface VoidAuthorizedPaymentsSignature {
|
|
|
35
36
|
* @param - Wix eCommerce order ID
|
|
36
37
|
* @param - Payment IDs
|
|
37
38
|
*/
|
|
38
|
-
(ecomOrderId: string, paymentIds: string[]): Promise<VoidAuthorizedPaymentsResponse & {
|
|
39
|
-
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors
|
|
39
|
+
(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
|
|
40
|
+
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
40
41
|
}>;
|
|
41
42
|
}
|
|
42
43
|
declare function captureAuthorizedPayments$1(httpClient: HttpClient): CaptureAuthorizedPaymentsSignature;
|
|
@@ -47,8 +48,8 @@ interface CaptureAuthorizedPaymentsSignature {
|
|
|
47
48
|
* @param - Wix eCommerce order ID
|
|
48
49
|
* @param - Capture payments information
|
|
49
50
|
*/
|
|
50
|
-
(ecomOrderId: string, payments: PaymentCapture[]): Promise<CaptureAuthorizedPaymentsResponse & {
|
|
51
|
-
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors
|
|
51
|
+
(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.status` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.void.reason` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.scheduledAction.actionType` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`> & {
|
|
52
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
52
53
|
}>;
|
|
53
54
|
}
|
|
54
55
|
declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
|
|
@@ -63,8 +64,8 @@ interface GetOrderSignature {
|
|
|
63
64
|
* @param - ID of the order to retrieve.
|
|
64
65
|
* @returns Fulfilled - The requested order.
|
|
65
66
|
*/
|
|
66
|
-
(_id: string): Promise<Order & {
|
|
67
|
-
__applicationErrorsType?: GetOrderApplicationErrors
|
|
67
|
+
(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
68
|
+
__applicationErrorsType?: GetOrderApplicationErrors;
|
|
68
69
|
}>;
|
|
69
70
|
}
|
|
70
71
|
declare function searchOrders$1(httpClient: HttpClient): SearchOrdersSignature;
|
|
@@ -86,7 +87,9 @@ interface SearchOrdersSignature {
|
|
|
86
87
|
* [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
87
88
|
* @param - Search options.
|
|
88
89
|
*/
|
|
89
|
-
(search: OrderSearch): Promise<SearchOrdersResponse
|
|
90
|
+
(search: OrderSearch): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
91
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
92
|
+
}[OrderNonNullablePaths]>>;
|
|
90
93
|
}
|
|
91
94
|
declare function createOrder$1(httpClient: HttpClient): CreateOrderSignature;
|
|
92
95
|
interface CreateOrderSignature {
|
|
@@ -102,8 +105,8 @@ interface CreateOrderSignature {
|
|
|
102
105
|
* @param - Order info.
|
|
103
106
|
* @returns Newly created order.
|
|
104
107
|
*/
|
|
105
|
-
(order: Order, options?: CreateOrderOptions
|
|
106
|
-
__applicationErrorsType?: CreateOrderApplicationErrors
|
|
108
|
+
(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
109
|
+
__applicationErrorsType?: CreateOrderApplicationErrors;
|
|
107
110
|
}>;
|
|
108
111
|
}
|
|
109
112
|
declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
|
|
@@ -137,8 +140,8 @@ interface UpdateOrderSignature {
|
|
|
137
140
|
* @param - Order ID.
|
|
138
141
|
* @returns Newly created order.
|
|
139
142
|
*/
|
|
140
|
-
(_id: string, order: UpdateOrder): Promise<Order & {
|
|
141
|
-
__applicationErrorsType?: UpdateOrderApplicationErrors
|
|
143
|
+
(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
144
|
+
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
142
145
|
}>;
|
|
143
146
|
}
|
|
144
147
|
declare function bulkUpdateOrders$1(httpClient: HttpClient): BulkUpdateOrdersSignature;
|
|
@@ -171,7 +174,9 @@ interface BulkUpdateOrdersSignature {
|
|
|
171
174
|
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
172
175
|
* @param - Orders to update.
|
|
173
176
|
*/
|
|
174
|
-
(orders: MaskedOrder[], options?: BulkUpdateOrdersOptions
|
|
177
|
+
(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
178
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
179
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
175
180
|
}
|
|
176
181
|
declare function cancelOrder$1(httpClient: HttpClient): CancelOrderSignature;
|
|
177
182
|
interface CancelOrderSignature {
|
|
@@ -182,8 +187,10 @@ interface CancelOrderSignature {
|
|
|
182
187
|
* The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
|
|
183
188
|
* @param - Order ID.
|
|
184
189
|
*/
|
|
185
|
-
(_id: string, options?: CancelOrderOptions
|
|
186
|
-
|
|
190
|
+
(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
|
|
191
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
192
|
+
}[OrderNonNullablePaths]> & {
|
|
193
|
+
__applicationErrorsType?: CancelOrderApplicationErrors;
|
|
187
194
|
}>;
|
|
188
195
|
}
|
|
189
196
|
declare function bulkUpdateOrderTags$1(httpClient: HttpClient): BulkUpdateOrderTagsSignature;
|
|
@@ -194,7 +201,7 @@ interface BulkUpdateOrderTagsSignature {
|
|
|
194
201
|
* > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
|
|
195
202
|
* @param - IDs of orders to update tags for.
|
|
196
203
|
*/
|
|
197
|
-
(orderIds: string[], options?: BulkUpdateOrderTagsOptions
|
|
204
|
+
(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
198
205
|
}
|
|
199
206
|
declare const onOrderApproved$1: EventDefinition<OrderApprovedEnvelope, "wix.ecom.v1.order_approved">;
|
|
200
207
|
declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.ecom.v1.order_updated">;
|