@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
|
@@ -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, R as RecordManuallyCollectedPaymentApplicationErrors, M as MarkOrderAsPaidResponse, d as PaymentCollectionMarkOrderAsPaidApplicationErrors, B as BulkMarkOrdersAsPaidResponse, e as GetRefundabilityStatusResponse, f as PaymentCollectionCreatePaymentGatewayOrderOptions, C as CreatePaymentGatewayOrderResponse, g as PaymentCollectionCreatePaymentGatewayOrderApplicationErrors, h as ChargeMembershipsOptions, i as PaymentRefund, T as TriggerRefundOptions, j as TriggerRefundResponse, k as TriggerRefundApplicationErrors, V as VoidAuthorizedPaymentsResponse, l as VoidAuthorizedPaymentsApplicationErrors, m as PaymentCapture, n as CaptureAuthorizedPaymentsResponse, o as CaptureAuthorizedPaymentsApplicationErrors, O as Order, p as GetOrderApplicationErrors, q as OrderSearch, S as SearchOrdersResponse, r as CreateOrderOptions, s as CreateOrderApplicationErrors, U as UpdateOrder, t as UpdateOrderApplicationErrors, u as MaskedOrder, v as BulkUpdateOrdersOptions, w as BulkUpdateOrdersResponse, x as CommitDeltasOptions, y as CommitDeltasResponse, z as CommitDeltasApplicationErrors, A as UpdateOrderLineItemIdentifiers, D as UpdateOrderLineItem, E as UpdateOrderLineItemResponse, F as PublicActivity, H as AddActivityResponse, I as UpdateActivityIdentifiers, J as UpdateActivityResponse, K as DeleteActivityIdentifiers, L as DeleteActivityResponse, N as CancelOrderOptions, Q as CancelOrderResponse, W as CancelOrderApplicationErrors, X as OrderStatusWithLiterals, Y as UpdateOrderStatusResponse, Z as UpdateOrderStatusApplicationErrors, _ as AggregateOrdersOptions, $ as AggregateOrdersResponse, a0 as BulkUpdateOrderTagsOptions, a1 as BulkUpdateOrderTagsResponse, a2 as OrderApprovedEnvelope, a3 as OrderUpdatedEnvelope, a4 as OrderCanceledEnvelope, a5 as OrderCreatedEnvelope } from './ecom-v1-order-orders.universal-EM8BrJdd.js';
|
|
3
3
|
export { e1 as ActionEvent, aA as ActionType, bT as Activity, bU as ActivityContentOneOf, am as ActivityType, gW as AddActivitiesRequest, gX as AddActivitiesResponse, gU as AddActivityRequest, gx as AddInternalActivityRequest, gT as AddInternalActivityResponse, cN as AdditionalFee, f$ as AdditionalFeeDelta, g0 as AdditionalFeeDeltaDeltaOneOf, dm as AdditionalFeeRefund, bv as Address, hN as AddressDescription, bx as AddressLocation, bu as AddressWithContact, ab as AdjustmentType, hu as AggregateOrdersRequest, dM as AggregatedRefundSummary, aG as AnimationDetection, eP as App, d6 as ApplicationError, bL as AppliedDiscount, fZ as AppliedDiscountDelta, f_ as AppliedDiscountDeltaDeltaOneOf, bM as AppliedDiscountDiscountSourceOneOf, g8 as ArchiveOrderRequest, g9 as ArchiveOrderResponse, an as AttributionSource, dB as AuthorizationActionFailureDetails, dA as AuthorizationCapture, ax as AuthorizationCaptureStatus, dz as AuthorizationDetails, dC as AuthorizationVoid, ay as AuthorizationVoidStatus, cf as AuthorizedPaymentCaptured, ce as AuthorizedPaymentCreated, cg as AuthorizedPaymentVoided, cM as Balance, cL as BalanceSummary, ie as BaseEventMetadata, fu as BatchOfTriggerReindexOrderRequest, hX as BigDecimalWrapper, bg as BillingAdjustment, bh as BillingAdjustmentPriceSummary, d7 as BulkActionMetadata, gc as BulkArchiveOrdersByFilterRequest, gd as BulkArchiveOrdersByFilterResponse, ga as BulkArchiveOrdersRequest, gb as BulkArchiveOrdersResponse, hb as BulkMarkAsFulfilledByFilterRequest, hc as BulkMarkAsFulfilledByFilterResponse, h9 as BulkMarkAsFulfilledRequest, ha as BulkMarkAsFulfilledResponse, hh as BulkMarkAsUnfulfilledByFilterRequest, hi as BulkMarkAsUnfulfilledByFilterResponse, hf as BulkMarkAsUnfulfilledRequest, hg as BulkMarkAsUnfulfilledResponse, d3 as BulkMarkOrdersAsPaidRequest, d4 as BulkOrderResult, ed as BulkSendBuyerPickupConfirmationEmailsRequest, ee as BulkSendBuyerPickupConfirmationEmailsResponse, eh as BulkSendBuyerShippingConfirmationEmailsRequest, ei as BulkSendBuyerShippingConfirmationEmailsResponse, hj as BulkSetBusinessLocationRequest, hk as BulkSetBusinessLocationResponse, hl as BulkSetBusinessLocationResult, gi as BulkUnArchiveOrdersByFilterRequest, gj as BulkUnArchiveOrdersByFilterResponse, gg as BulkUnArchiveOrdersRequest, gh as BulkUnArchiveOrdersResponse, hy as BulkUpdateOrderTagsRequest, hz as BulkUpdateOrderTagsResult, fO as BulkUpdateOrdersRequest, bq as BuyerInfo, br as BuyerInfoIdOneOf, gl as BuyerInfoUpdate, dQ as CalculateRefundItemRequest, dS as CalculateRefundItemResponse, dP as CalculateRefundRequest, dR as CalculateRefundResponse, i5 as CalculatedTax, i4 as CalculatedTaxes, hF as Cancel, h3 as CancelOrderRequest, dU as CaptureAuthorizedPaymentsRequest, aY as CatalogReference, cJ as ChannelInfo, ao as ChannelType, dd as ChargeMembershipsRequest, dh as ChargeMembershipsResponse, dV as ChargeSavedPaymentMethodRequest, dW as ChargeSavedPaymentMethodResponse, dE as Chargeback, cF as ChargebackCreated, cG as ChargebackReversed, aB as ChargebackStatus, dc as ChargedBy, b2 as Color, fP as CommitDeltasRequest, g4 as CommittedDiffs, g5 as CommittedDiffsShippingUpdateInfoOneOf, hQ as CommonAddress, hR as CommonAddressStreetOneOf, hP as Company, hE as Complete, fx as ContinueSideEffectsFlowInLegacyData, bN as Coupon, fI as CreateOrderRequest, fL as CreateOrderResponse, db as CreatePaymentGatewayOrderRequest, cH as CreatedBy, cI as CreatedByStringOneOf, cu as CreditCardDetails, dy as CreditCardPaymentMethodDetails, bs as CurrencyConversionDetails, e$ as CursorPaging, fH as CursorPagingMetadata, fF as CursorSearch, fG as CursorSearchPagingMethodOneOf, f2 as Cursors, bV as CustomActivity, cK as CustomField, aS as CustomFieldGroup, ia as CustomFieldValue, hK as Customer, hw as DecrementData, hv as DecrementItemsQuantityRequest, hx as DecrementItemsQuantityResponse, cZ as DelayedCaptureSettings, gZ as DeleteActivityRequest, fm as DeleteByFilterOperation, fl as DeleteByIdsOperation, bB as DeliveryLogistics, bC as DeliveryLogisticsAddressOneOf, bF as DeliveryTimeSlot, aN as DeltaPaymentOptionType, ic as Deposit, aU as DepositType, aZ as DescriptionLine, a$ as DescriptionLineDescriptionLineValueOneOf, b0 as DescriptionLineName, a6 as DescriptionLineType, a_ as DescriptionLineValueOneOf, fv as DiffmatokyPayload, ba as DigitalFile, i2 as Discount, i3 as DiscountOneDiscountTypeOneOf, ak as DiscountReason, bQ as DiscountRule, bR as DiscountRuleName, aj as DiscountType, dX as DomainEvent, dY as DomainEventBodyOneOf, gF as DownloadLinkSent, b$ as DraftOrderChangesApplied, g1 as DraftOrderCommitSettings, fQ as DraftOrderDiffs, fT as DraftOrderDiffsBillingUpdateInfoOneOf, fS as DraftOrderDiffsBuyerUpdateInfoOneOf, fU as DraftOrderDiffsRecipientUpdateInfoOneOf, fR as DraftOrderDiffsShippingUpdateInfoOneOf, c_ as Duration, aq as DurationUnit, hL as Email, gO as EmailEdited, e2 as Empty, dZ as EntityCreatedEvent, e0 as EntityDeletedEvent, d$ as EntityUpdatedEvent, fw as ErrorInformation, ig as EventMetadata, bm as ExtendedFields, cC as ExternalReceipt, dI as ExternalReceiptInfo, eT as ExternalUriMapping, b3 as FocalPoint, bf as FreeTrialPeriod, gM as FulfillerEmailSent, ae as FulfillmentStatus, h8 as FulfillmentStatusUpdated, cO as FulfillmentStatusesAggregate, by as FullAddressContactDetails, eM as GetMetasiteDataRequest, eN as GetMetasiteDataResponse, fb as GetOrderAgcRequest, fc as GetOrderAgcResponse, f3 as GetOrderForMetasiteRequest, f4 as GetOrderForMetasiteResponse, f9 as GetOrderOutOfBoxRequest, fa as GetOrderOutOfBoxResponse, fz as GetOrderRequest, fA as GetOrderResponse, fd as GetOrderWithFilterByLocationRequest, fe as GetOrderWithFilterByLocationResponse, c$ as GetPaymentCollectabilityStatusRequest, d8 as GetRefundabilityStatusRequest, hs as GetShipmentsRequest, ht as GetShipmentsResponse, dF as GiftCardPaymentDetails, cl as GiftCardPaymentRefund, eS as HtmlApplication, hI as IdAndVersion, e4 as IdentificationData, e5 as IdentificationDataIdOneOf, e6 as ImageContent, fy as IndexingMessage, gy as InternalActivity, gz as InternalActivityContentOneOf, fj as InternalDocument, fn as InternalDocumentUpdateByFilterOperation, fk as InternalDocumentUpdateOperation, eW as InternalQueryOrdersRequest, fB as InternalQueryOrdersResponse, fo as InternalUpdateExistingOperation, aO as InventoryAction, g2 as InventoryUpdateDetails, gK as InvoiceAdded, hU as InvoiceDates, i9 as InvoiceDynamicPriceTotals, hJ as InvoiceFields, gL as InvoiceSent, hH as InvoiceSentEvent, aV as InvoiceStatus, i7 as InvoicesPayment, fY as ItemChangedDetails, d5 as ItemMetadata, bp as ItemModifier, b7 as ItemTaxFullDetails, b5 as ItemType, a7 as ItemTypeItemType, b6 as ItemTypeItemTypeDataOneOf, i1 as ItemizedFee, a9 as JurisdictionType, hW as LineItem, c8 as LineItemAmount, c2 as LineItemChanges, g6 as LineItemDelta, g7 as LineItemDeltaDeltaOneOf, bS as LineItemDiscount, b_ as LineItemExchangeData, h_ as LineItemMetaData, c4 as LineItemPriceChange, c3 as LineItemQuantityChange, al as LineItemQuantityChangeType, dl as LineItemRefund, dO as LineItemRefundSummary, hY as LineItemTax, b9 as LineItemTaxBreakdown, b8 as LineItemTaxInfo, g$ as LineItemUpdate, hV as LineItems, f5 as ListOrderTransactionsForMetasiteRequest, f6 as ListOrderTransactionsForMetasiteResponse, h$ as Locale, cR as Location, bj as LocationAndQuantity, c9 as ManagedAdditionalFee, c6 as ManagedDiscount, c5 as ManagedLineItem, au as ManuallyRefundableReason, h6 as MarkAsFulfilledRequest, h7 as MarkAsFulfilledResponse, hd as MarkAsUnfulfilledRequest, he as MarkAsUnfulfilledResponse, d2 as MarkOrderAsPaidRequest, h1 as MarkOrderAsSeenByHumanRequest, h2 as MarkOrderAsSeenByHumanResponse, gv as MaskedOrderLineItem, de as MembershipChargeItem, df as MembershipName, dG as MembershipPaymentDetails, cm as MembershipPaymentRefund, aC as MembershipPaymentStatus, bW as MerchantComment, bO as MerchantDiscount, bP as MerchantDiscountMerchantDiscountReasonOneOf, e3 as MessageEnvelope, i8 as MetaData, eO as MetaSite, eR as MetaTag, bn as ModifierGroup, aJ as Namespace, bZ as NewExchangeOrderCreated, at as NonRefundableReason, aM as OrderApprovalStrategy, cS as OrderApproved, gE as OrderCanceled, h4 as OrderCanceledEventOrderCanceled, c0 as OrderChange, c1 as OrderChangeValueOneOf, fK as OrderCreateNotifications, bY as OrderCreatedFromExchange, fJ as OrderCreationSettings, g3 as OrderDeltasCommitted, gC as OrderFulfilled, cV as OrderItemsRestocked, aW as OrderLineItem, fX as OrderLineItemChangedDetails, gD as OrderNotFulfilled, gB as OrderPaid, gQ as OrderPartiallyPaid, gR as OrderPending, gA as OrderPlaced, bX as OrderRefunded, gS as OrderRejected, cU as OrderRejectedEventOrderRejected, ih as OrderSearchSpec, ai as OrderStatus, bK as OrderTaxBreakdown, bJ as OrderTaxInfo, ds as OrderTransactions, cT as OrdersExperiments, dt as Payment, cv as PaymentCanceled, cw as PaymentCanceledPaymentDetailsOneOf, ar as PaymentCollectabilityStatus, cx as PaymentDeclined, cy as PaymentDeclinedPaymentDetailsOneOf, a8 as PaymentOptionType, du as PaymentPaymentDetailsOneOf, cq as PaymentPending, cr as PaymentPendingPaymentDetailsOneOf, dv as PaymentReceiptInfoOneOf, co as PaymentRefundFailed, cn as PaymentRefunded, ad as PaymentStatus, eL as PaymentStatusUpdated, i6 as Payments, hO as Phone, b4 as PhysicalProperties, bE as PickupAddress, bD as PickupDetails, ah as PickupMethod, gP as PickupReadyEmailSent, aP as Placement, b1 as PlainTextValue, e_ as PlatformPaging, f1 as PlatformPagingMetadata, eX as PlatformQuery, eY as PlatformQueryPagingMethodOneOf, cX as PreparePaymentCollectionRequest, eB as PreviewBuyerConfirmationEmailRequest, eC as PreviewBuyerConfirmationEmailResponse, ez as PreviewBuyerPaymentsReceivedEmailRequest, eA as PreviewBuyerPaymentsReceivedEmailResponse, eD as PreviewBuyerPickupConfirmationEmailRequest, eE as PreviewBuyerPickupConfirmationEmailResponse, ev as PreviewCancelEmailRequest, ew as PreviewCancelEmailResponse, ex as PreviewCancelRefundEmailRequest, ey as PreviewCancelRefundEmailResponse, er as PreviewEmailByTypeRequest, es as PreviewEmailByTypeResponse, aH as PreviewEmailType, et as PreviewRefundEmailRequest, eu as PreviewRefundEmailResponse, eH as PreviewResendDownloadLinksEmailRequest, eI as PreviewResendDownloadLinksEmailResponse, eF as PreviewShippingConfirmationEmailRequest, eG as PreviewShippingConfirmationEmailResponse, bi as PriceDescription, bt as PriceSummary, aX as ProductName, gV as PublicActivityContentOneOf, fC as QueryOrderRequest, fD as QueryOrderResponse, eV as QueryOrdersForMetasiteRequest, f0 as QueryOrdersForMetasiteResponse, hM as QuotesAddress, az as Reason, cz as ReceiptCreated, cA as ReceiptCreatedReceiptInfoOneOf, cD as ReceiptSent, cE as ReceiptSentReceiptInfoOneOf, d0 as RecordManuallyCollectedPaymentRequest, d1 as RecordManuallyCollectedPaymentResponse, cY as RedirectUrls, dJ as Refund, dj as RefundDetails, ch as RefundInitiated, dk as RefundItem, dN as RefundItemsBreakdown, dp as RefundSideEffects, aD as RefundStatus, dL as RefundStatusInfo, dK as RefundTransaction, d9 as Refundability, da as RefundabilityAdditionalRefundabilityInfoOneOf, as as RefundableStatus, cp as RefundedAsStoreCredit, ci as RefundedPayment, cj as RefundedPaymentKindOneOf, cs as RegularPayment, dw as RegularPaymentDetails, dx as RegularPaymentDetailsPaymentMethodDetailsOneOf, ct as RegularPaymentPaymentMethodDetailsOneOf, ck as RegularPaymentRefund, hG as Reschedule, dq as RestockInfo, dr as RestockItem, av as RestockType, d_ as RestoreInfo, cd as SavedPaymentMethod, ap as ScheduledAction, fE as SearchOrdersRequest, e7 as SendBuyerConfirmationEmailRequest, e8 as SendBuyerConfirmationEmailResponse, e9 as SendBuyerPaymentsReceivedEmailRequest, ea as SendBuyerPaymentsReceivedEmailResponse, eb as SendBuyerPickupConfirmationEmailRequest, ec as SendBuyerPickupConfirmationEmailResponse, ef as SendBuyerShippingConfirmationEmailRequest, eg as SendBuyerShippingConfirmationEmailResponse, el as SendCancelRefundEmailRequest, em as SendCancelRefundEmailResponse, ej as SendMerchantOrderReceivedNotificationRequest, ek as SendMerchantOrderReceivedNotificationResponse, ep as SendMerchantOrderReceivedPushRequest, eq as SendMerchantOrderReceivedPushResponse, en as SendRefundEmailRequest, eo as SendRefundEmailResponse, eQ as SeoData, dg as ServiceProperties, gN as ShippingAddressEdited, gJ as ShippingConfirmationEmailSent, cc as ShippingInformation, cb as ShippingInformationChange, bG as ShippingPrice, dn as ShippingRefund, bH as ShippingRegion, eK as SnapshotMessage, aK as SortOrder, eZ as Sorting, hZ as Source, aR as SourceType, hT as StandardDetails, aI as State, bw as StreetAddress, hS as Subdivision, aQ as SubdivisionType, bd as SubscriptionDescription, aa as SubscriptionFrequency, bb as SubscriptionInfo, be as SubscriptionSettings, bc as SubscriptionTitle, cQ as TagList, cP as Tags, hA as Task, hC as TaskAction, hD as TaskActionActionOneOf, hB as TaskKey, bI as TaxSummary, bk as TaxableAddress, bl as TaxableAddressTaxableAddressDataOneOf, ac as TaxableAddressType, aF as TextDetection, i0 as TotalPrice, ca as TotalPriceChange, gI as TrackingLinkAdded, gG as TrackingNumberAdded, gH as TrackingNumberEdited, aw as TransactionStatus, bo as TranslatableString, c7 as TranslatedValue, di as TriggerRefundRequest, eJ as TriggerReindexOrderRequest, fs as TriggerReindexRequest, ft as TriggerReindexResponse, id as TriggerSideEffectsFromLegacyData, ge as UnArchiveOrderRequest, gf as UnArchiveOrderResponse, gY as UpdateActivityRequest, gr as UpdateBillingContactDetailsRequest, gs as UpdateBillingContactDetailsResponse, gn as UpdateBuyerEmailRequest, go as UpdateBuyerEmailResponse, gk as UpdateBuyerInfoRequest, gm as UpdateBuyerInfoResponse, fh as UpdateInternalDocumentsEvent, fi as UpdateInternalDocumentsEventOperationOneOf, g_ as UpdateLineItemsDescriptionLinesRequest, h0 as UpdateLineItemsDescriptionLinesResponse, gt as UpdateOrderLineItemRequest, gu as UpdateOrderLineItemsRequest, gw as UpdateOrderLineItemsResponse, fM as UpdateOrderRequest, fN as UpdateOrderResponse, gp as UpdateOrderShippingAddressRequest, gq as UpdateOrderShippingAddressResponse, h5 as UpdateOrderStatusRequest, f7 as UpsertRefundRequest, f8 as UpsertRefundResponse, eU as UserDataResponse, ho as V1BulkMarkOrdersAsPaidRequest, hp as V1BulkMarkOrdersAsPaidResponse, hq as V1CreatePaymentGatewayOrderRequest, hr as V1CreatePaymentGatewayOrderResponse, fV as V1LineItemDelta, fW as V1LineItemDeltaDeltaOneOf, hm as V1MarkOrderAsPaidRequest, hn as V1MarkOrderAsPaidResponse, cW as V1RestockItem, dD as V1ScheduledAction, bA as V1ShippingInformation, ff as V1UpdateOrderRequest, fg as V1UpdateOrderResponse, ib as Value, aT as ValueType, bz as VatId, ag as VatType, fq as VersionedDeleteByIdsOperation, fr as VersionedDocumentId, fp as VersionedDocumentUpdateOperation, aL as VersioningMode, dT as VoidAuthorizedPaymentsRequest, aE as WebhookIdentityType, af as WeightUnit, cB as WixReceipt, dH as WixReceiptInfo } from './ecom-v1-order-orders.universal-EM8BrJdd.js';
|
|
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
|
/** @internal */
|
|
31
32
|
declare function recordManuallyCollectedPayment$1(httpClient: HttpClient): RecordManuallyCollectedPaymentSignature;
|
|
@@ -38,7 +39,7 @@ interface RecordManuallyCollectedPaymentSignature {
|
|
|
38
39
|
* @param - Amount to be recorded as approved manual payment for given order
|
|
39
40
|
*/
|
|
40
41
|
(orderId: string, amount: Price): Promise<void & {
|
|
41
|
-
__applicationErrorsType?: RecordManuallyCollectedPaymentApplicationErrors
|
|
42
|
+
__applicationErrorsType?: RecordManuallyCollectedPaymentApplicationErrors;
|
|
42
43
|
}>;
|
|
43
44
|
}
|
|
44
45
|
/** @internal */
|
|
@@ -53,8 +54,10 @@ interface PaymentCollectionMarkOrderAsPaidSignature {
|
|
|
53
54
|
* will be created and approved.
|
|
54
55
|
* @param - Ecom order ID.
|
|
55
56
|
*/
|
|
56
|
-
(ecomOrderId: string): Promise<MarkOrderAsPaidResponse
|
|
57
|
-
|
|
57
|
+
(ecomOrderId: string): Promise<NonNullablePaths<MarkOrderAsPaidResponse, {
|
|
58
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
59
|
+
}[OrderNonNullablePaths]> & {
|
|
60
|
+
__applicationErrorsType?: PaymentCollectionMarkOrderAsPaidApplicationErrors;
|
|
58
61
|
}>;
|
|
59
62
|
}
|
|
60
63
|
/** @internal */
|
|
@@ -64,7 +67,9 @@ interface PaymentCollectionBulkMarkOrdersAsPaidSignature {
|
|
|
64
67
|
* Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
65
68
|
* @param - IDs of orders to mark as paid.
|
|
66
69
|
*/
|
|
67
|
-
(ecomOrderIds: string[]): Promise<BulkMarkOrdersAsPaidResponse
|
|
70
|
+
(ecomOrderIds: string[]): Promise<NonNullablePaths<BulkMarkOrdersAsPaidResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
71
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
72
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
68
73
|
}
|
|
69
74
|
/** @internal */
|
|
70
75
|
declare function getRefundabilityStatus$1(httpClient: HttpClient): GetRefundabilityStatusSignature;
|
|
@@ -73,7 +78,7 @@ interface GetRefundabilityStatusSignature {
|
|
|
73
78
|
* Checks whether this order can be refunded.
|
|
74
79
|
* @param - Order ID.
|
|
75
80
|
*/
|
|
76
|
-
(ecomOrderId: string): Promise<GetRefundabilityStatusResponse
|
|
81
|
+
(ecomOrderId: string): Promise<NonNullablePaths<GetRefundabilityStatusResponse, `refundabilities` | `refundabilities.${number}.nonRefundableReason` | `refundabilities.${number}.manuallyRefundableReason` | `refundabilities.${number}.paymentId` | `refundabilities.${number}.refundabilityStatus` | `refundablePerItem`>>;
|
|
77
82
|
}
|
|
78
83
|
/** @internal */
|
|
79
84
|
declare function paymentCollectionCreatePaymentGatewayOrder$1(httpClient: HttpClient): PaymentCollectionCreatePaymentGatewayOrderSignature;
|
|
@@ -86,8 +91,8 @@ interface PaymentCollectionCreatePaymentGatewayOrderSignature {
|
|
|
86
91
|
* 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).
|
|
87
92
|
* @param - Ecom order ID.
|
|
88
93
|
*/
|
|
89
|
-
(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions
|
|
90
|
-
__applicationErrorsType?: PaymentCollectionCreatePaymentGatewayOrderApplicationErrors
|
|
94
|
+
(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions): Promise<NonNullablePaths<CreatePaymentGatewayOrderResponse, `paymentGatewayOrderId`> & {
|
|
95
|
+
__applicationErrorsType?: PaymentCollectionCreatePaymentGatewayOrderApplicationErrors;
|
|
91
96
|
}>;
|
|
92
97
|
}
|
|
93
98
|
/** @internal */
|
|
@@ -98,7 +103,7 @@ interface ChargeMembershipsSignature {
|
|
|
98
103
|
* @param - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
99
104
|
* but a user which is using the membership on behalf of the a member
|
|
100
105
|
*/
|
|
101
|
-
(ecomOrderId: string, memberId: string, options?: ChargeMembershipsOptions |
|
|
106
|
+
(ecomOrderId: string, memberId: string, options?: NonNullablePaths<ChargeMembershipsOptions, `membershipCharges.${number}.appId` | `membershipCharges.${number}.catalogReference` | `membershipCharges.${number}.catalogReference.appId` | `membershipCharges.${number}.catalogReference.catalogItemId` | `membershipCharges.${number}.membershipId` | `membershipCharges.${number}.membershipName` | `membershipCharges.${number}.membershipName.original` | `membershipCharges.${number}.rootCatalogItemId`>): Promise<void>;
|
|
102
107
|
}
|
|
103
108
|
/** @internal */
|
|
104
109
|
declare function triggerRefund$1(httpClient: HttpClient): TriggerRefundSignature;
|
|
@@ -111,8 +116,8 @@ interface TriggerRefundSignature {
|
|
|
111
116
|
* @param - The order this refund related to
|
|
112
117
|
* @param - Refund operations information
|
|
113
118
|
*/
|
|
114
|
-
(ecomOrderId: string, payments: PaymentRefund[], options?: TriggerRefundOptions
|
|
115
|
-
__applicationErrorsType?: TriggerRefundApplicationErrors
|
|
119
|
+
(ecomOrderId: string, payments: NonNullablePaths<PaymentRefund, `paymentId`>[], options?: TriggerRefundOptions): Promise<NonNullablePaths<TriggerRefundResponse, `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` | `failedPaymentIds` | `failedPaymentIds.${number}.originalIndex` | `failedPaymentIds.${number}.success` | `failedPaymentIds.${number}.error.code` | `failedPaymentIds.${number}.error.description`> & {
|
|
120
|
+
__applicationErrorsType?: TriggerRefundApplicationErrors;
|
|
116
121
|
}>;
|
|
117
122
|
}
|
|
118
123
|
declare function voidAuthorizedPayments$1(httpClient: HttpClient): VoidAuthorizedPaymentsSignature;
|
|
@@ -123,8 +128,8 @@ interface VoidAuthorizedPaymentsSignature {
|
|
|
123
128
|
* @param - Wix eCommerce order ID
|
|
124
129
|
* @param - Payment IDs
|
|
125
130
|
*/
|
|
126
|
-
(ecomOrderId: string, paymentIds: string[]): Promise<VoidAuthorizedPaymentsResponse & {
|
|
127
|
-
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors
|
|
131
|
+
(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`> & {
|
|
132
|
+
__applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
|
|
128
133
|
}>;
|
|
129
134
|
}
|
|
130
135
|
declare function captureAuthorizedPayments$1(httpClient: HttpClient): CaptureAuthorizedPaymentsSignature;
|
|
@@ -135,8 +140,8 @@ interface CaptureAuthorizedPaymentsSignature {
|
|
|
135
140
|
* @param - Wix eCommerce order ID
|
|
136
141
|
* @param - Capture payments information
|
|
137
142
|
*/
|
|
138
|
-
(ecomOrderId: string, payments: PaymentCapture[]): Promise<CaptureAuthorizedPaymentsResponse & {
|
|
139
|
-
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors
|
|
143
|
+
(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`> & {
|
|
144
|
+
__applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
|
|
140
145
|
}>;
|
|
141
146
|
}
|
|
142
147
|
declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
|
|
@@ -151,8 +156,8 @@ interface GetOrderSignature {
|
|
|
151
156
|
* @param - ID of the order to retrieve.
|
|
152
157
|
* @returns Fulfilled - The requested order.
|
|
153
158
|
*/
|
|
154
|
-
(_id: string): Promise<Order & {
|
|
155
|
-
__applicationErrorsType?: GetOrderApplicationErrors
|
|
159
|
+
(_id: string): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
160
|
+
__applicationErrorsType?: GetOrderApplicationErrors;
|
|
156
161
|
}>;
|
|
157
162
|
}
|
|
158
163
|
declare function searchOrders$1(httpClient: HttpClient): SearchOrdersSignature;
|
|
@@ -174,7 +179,9 @@ interface SearchOrdersSignature {
|
|
|
174
179
|
* [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
175
180
|
* @param - Search options.
|
|
176
181
|
*/
|
|
177
|
-
(search: OrderSearch): Promise<SearchOrdersResponse
|
|
182
|
+
(search: OrderSearch): Promise<NonNullablePaths<SearchOrdersResponse, {
|
|
183
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
184
|
+
}[OrderNonNullablePaths]>>;
|
|
178
185
|
}
|
|
179
186
|
declare function createOrder$1(httpClient: HttpClient): CreateOrderSignature;
|
|
180
187
|
interface CreateOrderSignature {
|
|
@@ -190,8 +197,8 @@ interface CreateOrderSignature {
|
|
|
190
197
|
* @param - Order info.
|
|
191
198
|
* @returns Newly created order.
|
|
192
199
|
*/
|
|
193
|
-
(order: Order, options?: CreateOrderOptions
|
|
194
|
-
__applicationErrorsType?: CreateOrderApplicationErrors
|
|
200
|
+
(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> & {
|
|
201
|
+
__applicationErrorsType?: CreateOrderApplicationErrors;
|
|
195
202
|
}>;
|
|
196
203
|
}
|
|
197
204
|
declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
|
|
@@ -225,8 +232,8 @@ interface UpdateOrderSignature {
|
|
|
225
232
|
* @param - Order ID.
|
|
226
233
|
* @returns Newly created order.
|
|
227
234
|
*/
|
|
228
|
-
(_id: string, order: UpdateOrder): Promise<Order & {
|
|
229
|
-
__applicationErrorsType?: UpdateOrderApplicationErrors
|
|
235
|
+
(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, OrderNonNullablePaths> & {
|
|
236
|
+
__applicationErrorsType?: UpdateOrderApplicationErrors;
|
|
230
237
|
}>;
|
|
231
238
|
}
|
|
232
239
|
declare function bulkUpdateOrders$1(httpClient: HttpClient): BulkUpdateOrdersSignature;
|
|
@@ -259,21 +266,27 @@ interface BulkUpdateOrdersSignature {
|
|
|
259
266
|
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
260
267
|
* @param - Orders to update.
|
|
261
268
|
*/
|
|
262
|
-
(orders: MaskedOrder[], options?: BulkUpdateOrdersOptions
|
|
269
|
+
(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` | {
|
|
270
|
+
[P in OrderNonNullablePaths]: `results.${number}.item.${P}`;
|
|
271
|
+
}[OrderNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
263
272
|
}
|
|
264
273
|
/** @internal */
|
|
265
274
|
declare function commitDeltas$1(httpClient: HttpClient): CommitDeltasSignature;
|
|
266
275
|
interface CommitDeltasSignature {
|
|
267
276
|
/** @param - Order id to be updated */
|
|
268
|
-
(_id: string, options?: CommitDeltasOptions |
|
|
269
|
-
|
|
277
|
+
(_id: string, options?: NonNullablePaths<CommitDeltasOptions, `changes` | `changes.priceSummary.subtotal` | `changes.priceSummary.total`>): Promise<NonNullablePaths<CommitDeltasResponse, {
|
|
278
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
279
|
+
}[OrderNonNullablePaths]> & {
|
|
280
|
+
__applicationErrorsType?: CommitDeltasApplicationErrors;
|
|
270
281
|
}>;
|
|
271
282
|
}
|
|
272
283
|
/** @internal */
|
|
273
284
|
declare function updateOrderLineItem$1(httpClient: HttpClient): UpdateOrderLineItemSignature;
|
|
274
285
|
interface UpdateOrderLineItemSignature {
|
|
275
286
|
/** @deprecated */
|
|
276
|
-
(identifiers: UpdateOrderLineItemIdentifiers, lineItem: UpdateOrderLineItem): Promise<UpdateOrderLineItemResponse
|
|
287
|
+
(identifiers: NonNullablePaths<UpdateOrderLineItemIdentifiers, `_id` | `lineItemId`>, lineItem: UpdateOrderLineItem): Promise<NonNullablePaths<UpdateOrderLineItemResponse, {
|
|
288
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
289
|
+
}[OrderNonNullablePaths]>>;
|
|
277
290
|
}
|
|
278
291
|
/** @internal */
|
|
279
292
|
declare function addActivity$1(httpClient: HttpClient): AddActivitySignature;
|
|
@@ -285,7 +298,9 @@ interface AddActivitySignature {
|
|
|
285
298
|
* @param - Activity info.
|
|
286
299
|
* @deprecated
|
|
287
300
|
*/
|
|
288
|
-
(_id: string, activity: PublicActivity): Promise<AddActivityResponse
|
|
301
|
+
(_id: string, activity: PublicActivity): Promise<NonNullablePaths<AddActivityResponse, {
|
|
302
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
303
|
+
}[OrderNonNullablePaths] | `activityId`>>;
|
|
289
304
|
}
|
|
290
305
|
/** @internal */
|
|
291
306
|
declare function updateActivity$1(httpClient: HttpClient): UpdateActivitySignature;
|
|
@@ -294,7 +309,9 @@ interface UpdateActivitySignature {
|
|
|
294
309
|
* Updates an order's activity.
|
|
295
310
|
* @param - Activity info.
|
|
296
311
|
*/
|
|
297
|
-
(identifiers: UpdateActivityIdentifiers, activity: PublicActivity): Promise<UpdateActivityResponse
|
|
312
|
+
(identifiers: NonNullablePaths<UpdateActivityIdentifiers, `_id` | `activityId`>, activity: PublicActivity): Promise<NonNullablePaths<UpdateActivityResponse, {
|
|
313
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
314
|
+
}[OrderNonNullablePaths]>>;
|
|
298
315
|
}
|
|
299
316
|
/** @internal */
|
|
300
317
|
declare function deleteActivity$1(httpClient: HttpClient): DeleteActivitySignature;
|
|
@@ -304,7 +321,9 @@ interface DeleteActivitySignature {
|
|
|
304
321
|
*
|
|
305
322
|
* Only custom activities and merchant comments can be deleted.
|
|
306
323
|
*/
|
|
307
|
-
(identifiers: DeleteActivityIdentifiers): Promise<DeleteActivityResponse
|
|
324
|
+
(identifiers: NonNullablePaths<DeleteActivityIdentifiers, `_id` | `activityId`>): Promise<NonNullablePaths<DeleteActivityResponse, {
|
|
325
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
326
|
+
}[OrderNonNullablePaths]>>;
|
|
308
327
|
}
|
|
309
328
|
declare function cancelOrder$1(httpClient: HttpClient): CancelOrderSignature;
|
|
310
329
|
interface CancelOrderSignature {
|
|
@@ -315,8 +334,10 @@ interface CancelOrderSignature {
|
|
|
315
334
|
* The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
|
|
316
335
|
* @param - Order ID.
|
|
317
336
|
*/
|
|
318
|
-
(_id: string, options?: CancelOrderOptions
|
|
319
|
-
|
|
337
|
+
(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, {
|
|
338
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
339
|
+
}[OrderNonNullablePaths]> & {
|
|
340
|
+
__applicationErrorsType?: CancelOrderApplicationErrors;
|
|
320
341
|
}>;
|
|
321
342
|
}
|
|
322
343
|
/** @internal */
|
|
@@ -339,15 +360,17 @@ interface UpdateOrderStatusSignature {
|
|
|
339
360
|
* @param - Order ID.
|
|
340
361
|
* @param - New order status.
|
|
341
362
|
*/
|
|
342
|
-
(orderId: string, status: OrderStatusWithLiterals): Promise<UpdateOrderStatusResponse
|
|
343
|
-
|
|
363
|
+
(orderId: string, status: OrderStatusWithLiterals): Promise<NonNullablePaths<UpdateOrderStatusResponse, {
|
|
364
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
365
|
+
}[OrderNonNullablePaths]> & {
|
|
366
|
+
__applicationErrorsType?: UpdateOrderStatusApplicationErrors;
|
|
344
367
|
}>;
|
|
345
368
|
}
|
|
346
369
|
/** @internal */
|
|
347
370
|
declare function aggregateOrders$1(httpClient: HttpClient): AggregateOrdersSignature;
|
|
348
371
|
interface AggregateOrdersSignature {
|
|
349
372
|
/** */
|
|
350
|
-
(options?: AggregateOrdersOptions
|
|
373
|
+
(options?: NonNullablePaths<AggregateOrdersOptions, `aggregation`>): Promise<AggregateOrdersResponse>;
|
|
351
374
|
}
|
|
352
375
|
declare function bulkUpdateOrderTags$1(httpClient: HttpClient): BulkUpdateOrderTagsSignature;
|
|
353
376
|
interface BulkUpdateOrderTagsSignature {
|
|
@@ -357,7 +380,7 @@ interface BulkUpdateOrderTagsSignature {
|
|
|
357
380
|
* > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
|
|
358
381
|
* @param - IDs of orders to update tags for.
|
|
359
382
|
*/
|
|
360
|
-
(orderIds: string[], options?: BulkUpdateOrderTagsOptions
|
|
383
|
+
(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`>>;
|
|
361
384
|
}
|
|
362
385
|
declare const onOrderApproved$1: EventDefinition<OrderApprovedEnvelope, "wix.ecom.v1.order_approved">;
|
|
363
386
|
declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.ecom.v1.order_updated">;
|