@wix/auto_sdk_ecom_orders 1.0.322 → 1.0.324

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.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-B_W1TM1T.d.ts → ecom-v1-order-orders.universal-CioVnQwu.d.ts} +1711 -1699
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +89 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +89 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1712 -1700
  9. package/build/cjs/meta.js +89 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-B_W1TM1T.d.mts → ecom-v1-order-orders.universal-CioVnQwu.d.mts} +1711 -1699
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +88 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +88 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1712 -1700
  19. package/build/es/meta.mjs +88 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-4KAOT3ls.d.ts → ecom-v1-order-orders.universal-aVj7Mb1n.d.ts} +1901 -1800
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1902 -1801
  25. package/build/internal/es/{ecom-v1-order-orders.universal-4KAOT3ls.d.mts → ecom-v1-order-orders.universal-aVj7Mb1n.d.mts} +1901 -1800
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1902 -1801
  29. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { ey as ImportOrderRequest$1, I as ImportOrderResponse$1, ez as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eA as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fV as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fZ as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, f_ as RecordManuallyCollectedPaymentRequest$1, g1 as RecordManuallyCollectedPaymentResponse$1, g2 as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, g3 as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, g8 as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, gb as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, gd as ChargeMembershipsRequest$1, gg as ChargeMembershipsResponse$1, gh as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gV as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gW as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h2 as GetOrderRequest$1, h3 as GetOrderResponse$1, hf as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hj as CreateOrderRequest$1, hn as CreateOrderResponse$1, ho as UpdateOrderRequest$1, hp as UpdateOrderResponse$1, hq as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hV as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, il as AddActivityRequest$1, N as AddActivityResponse$1, io as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ip as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, iq as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iw as CancelOrderRequest$1, a0 as CancelOrderResponse$1, ix as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iV as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iZ as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-4KAOT3ls.mjs';
1
+ import { eB as ImportOrderRequest$1, I as ImportOrderResponse$1, eC as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, eD as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, eH as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, eL as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, eM as RecordManuallyCollectedPaymentRequest$1, eP as RecordManuallyCollectedPaymentResponse$1, eQ as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eR as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eW as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eZ as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, e$ as ChargeMembershipsRequest$1, f2 as ChargeMembershipsResponse$1, f3 as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fM as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fN as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h5 as GetOrderRequest$1, h6 as GetOrderResponse$1, hi as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hm as CreateOrderRequest$1, hq as CreateOrderResponse$1, hr as UpdateOrderRequest$1, hs as UpdateOrderResponse$1, ht as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hY as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ip as AddActivityRequest$1, N as AddActivityResponse$1, ir as AddActivitiesRequest$1, W as AddActivitiesResponse$1, is as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, it as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iz as CancelOrderRequest$1, a0 as CancelOrderResponse$1, iA as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iY as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, j0 as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-aVj7Mb1n.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -2073,6 +2073,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
2073
2073
  merchantDiscount?: MerchantDiscount;
2074
2074
  /** Automatic discount applied by the system based on configured discount rules. */
2075
2075
  discountRule?: DiscountRule;
2076
+ /** Discount type. */
2076
2077
  discountType?: DiscountTypeWithLiterals;
2077
2078
  /**
2078
2079
  * __Deprecated.__ Use `lineItemDiscounts` instead.
@@ -2138,16 +2139,76 @@ declare enum DiscountType {
2138
2139
  /** @enumType */
2139
2140
  type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
2140
2141
  /** Coupon */
2141
- interface Coupon {
2142
+ interface Coupon extends CouponDiscountValueOneOf {
2143
+ /**
2144
+ * Percentage the coupon took off the price. For example, `10.5` for 10.5%.
2145
+ *
2146
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2147
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2148
+ * @internal
2149
+ * @format DECIMAL_VALUE
2150
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2151
+ */
2152
+ percentage?: string;
2142
2153
  /** Coupon ID. */
2143
2154
  id?: string;
2144
2155
  /** Coupon code. */
2145
2156
  code?: string;
2146
2157
  /** Coupon name. */
2147
2158
  name?: string;
2148
- /** Coupon value. */
2159
+ /** Total amount the coupon took off. */
2149
2160
  amount?: Price;
2161
+ /**
2162
+ * How the coupon's discount is expressed. `percentage` holds the rate of a percentage coupon, and `amount` holds
2163
+ * the total amount the coupon took off, whatever the type.
2164
+ *
2165
+ * Not returned for a free-shipping coupon.
2166
+ * @internal
2167
+ */
2168
+ discountValueType?: DiscountValueTypeWithLiterals;
2169
+ }
2170
+ /** @oneof */
2171
+ interface CouponDiscountValueOneOf {
2172
+ /**
2173
+ * Percentage the coupon took off the price. For example, `10.5` for 10.5%.
2174
+ *
2175
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2176
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2177
+ * @internal
2178
+ * @format DECIMAL_VALUE
2179
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2180
+ */
2181
+ percentage?: string;
2182
+ }
2183
+ /** How a coupon's or discount rule's discount value is expressed. */
2184
+ declare enum DiscountValueType {
2185
+ /**
2186
+ * The discount takes a percentage off the price it applies to.
2187
+ * @documentationMaturity preview
2188
+ * @internal
2189
+ */
2190
+ PERCENTAGE = "PERCENTAGE",
2191
+ /**
2192
+ * The discount takes a fixed amount off the price it applies to.
2193
+ * @documentationMaturity preview
2194
+ * @internal
2195
+ */
2196
+ FIXED_AMOUNT = "FIXED_AMOUNT",
2197
+ /**
2198
+ * The discount sets the price it applies to a fixed amount.
2199
+ * @documentationMaturity preview
2200
+ * @internal
2201
+ */
2202
+ FIXED_PRICE = "FIXED_PRICE",
2203
+ /**
2204
+ * The discount depends on the number of units bought. For example, 3 for $10, or buy 2 get 1 free.
2205
+ * @documentationMaturity preview
2206
+ * @internal
2207
+ */
2208
+ QUANTITY_BASED = "QUANTITY_BASED"
2150
2209
  }
2210
+ /** @enumType */
2211
+ type DiscountValueTypeWithLiterals = DiscountValueType;
2151
2212
  /** Discount applied manually by the merchant through the dashboard. */
2152
2213
  interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
2153
2214
  /** Predefined discount reason. */
@@ -2194,7 +2255,17 @@ declare enum DiscountReason {
2194
2255
  }
2195
2256
  /** @enumType */
2196
2257
  type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
2197
- interface DiscountRule {
2258
+ interface DiscountRule extends DiscountRuleDiscountValueOneOf {
2259
+ /**
2260
+ * Percentage the discount rule took off the price. For example, `10.5` for 10.5%.
2261
+ *
2262
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2263
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2264
+ * @internal
2265
+ * @format DECIMAL_VALUE
2266
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2267
+ */
2268
+ percentage?: string;
2198
2269
  /**
2199
2270
  * Discount rule ID
2200
2271
  * @format GUID
@@ -2202,8 +2273,29 @@ interface DiscountRule {
2202
2273
  id?: string;
2203
2274
  /** Discount rule name */
2204
2275
  name?: DiscountRuleName;
2205
- /** Discount value. */
2276
+ /** Total amount the discount rule took off. */
2206
2277
  amount?: Price;
2278
+ /**
2279
+ * How the discount rule's discount is expressed. `percentage` holds the rate of a percentage discount rule, and
2280
+ * `amount` holds the total amount the discount rule took off, whatever the type.
2281
+ *
2282
+ * Not returned for a free-shipping discount rule.
2283
+ * @internal
2284
+ */
2285
+ discountValueType?: DiscountValueTypeWithLiterals;
2286
+ }
2287
+ /** @oneof */
2288
+ interface DiscountRuleDiscountValueOneOf {
2289
+ /**
2290
+ * Percentage the discount rule took off the price. For example, `10.5` for 10.5%.
2291
+ *
2292
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2293
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2294
+ * @internal
2295
+ * @format DECIMAL_VALUE
2296
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2297
+ */
2298
+ percentage?: string;
2207
2299
  }
2208
2300
  interface DiscountRuleName {
2209
2301
  /**
@@ -2227,6 +2319,15 @@ interface LineItemDiscount {
2227
2319
  id?: string;
2228
2320
  /** Total discount amount for this line item. */
2229
2321
  totalDiscount?: Price;
2322
+ /**
2323
+ * Number of the line item's units the discount was applied to.
2324
+ *
2325
+ * Returned only for a `SPECIFIC_ITEMS` discount.
2326
+ * @internal
2327
+ * @min 1
2328
+ * @max 100000
2329
+ */
2330
+ discountedQuantity?: number | null;
2230
2331
  }
2231
2332
  interface ItemCombination {
2232
2333
  /**
@@ -4803,2328 +4904,2328 @@ interface BulkDeleteImportedOrdersResponse {
4803
4904
  */
4804
4905
  jobId?: string;
4805
4906
  }
4806
- interface SendBuyerConfirmationEmailRequest {
4907
+ interface V1TriggerReindexRequest {
4807
4908
  /** @format GUID */
4808
- orderId?: string;
4809
- }
4810
- interface SendBuyerConfirmationEmailResponse {
4811
- }
4812
- interface SendBuyerPaymentsReceivedEmailRequest {
4909
+ metasiteId?: string;
4813
4910
  /**
4814
4911
  * @minLength 1
4815
4912
  * @maxLength 100
4913
+ * @maxSize 100
4816
4914
  */
4817
- orderId?: string;
4915
+ orderIds?: string[];
4818
4916
  }
4819
- interface SendBuyerPaymentsReceivedEmailResponse {
4917
+ interface V1TriggerReindexResponse {
4820
4918
  }
4821
- interface SendBuyerPickupConfirmationEmailRequest {
4919
+ interface V1TriggerReindexOrderRequest {
4920
+ /** @format GUID */
4921
+ metasiteId?: string;
4822
4922
  /**
4823
4923
  * @minLength 1
4824
4924
  * @maxLength 100
4825
4925
  */
4826
4926
  orderId?: string;
4827
4927
  }
4828
- interface SendBuyerPickupConfirmationEmailResponse {
4829
- }
4830
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
4831
- /**
4832
- * IDs of orders to send pickup emails for.
4833
- * @minSize 1
4834
- * @maxSize 300
4835
- */
4836
- orderIds?: string[];
4837
- }
4838
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
4839
- }
4840
- interface SendBuyerShippingConfirmationEmailRequest {
4928
+ interface PreparePaymentCollectionRequest {
4841
4929
  /**
4930
+ * Ecom order ID.
4842
4931
  * @minLength 1
4843
4932
  * @maxLength 100
4844
4933
  */
4845
- orderId?: string;
4846
- }
4847
- interface SendBuyerShippingConfirmationEmailResponse {
4848
- }
4849
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
4934
+ ecomOrderId: string;
4935
+ /** Amount to collect */
4936
+ amount: Price;
4850
4937
  /**
4851
- * IDs of orders to send pickup emails for.
4852
- * @minSize 1
4853
- * @maxSize 300
4938
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4939
+ * Existing payment gateway order will be updated with a new amount.
4940
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4854
4941
  */
4855
- orderIds?: string[];
4856
- }
4857
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
4858
- }
4859
- interface SendMerchantOrderReceivedNotificationRequest {
4942
+ paymentGatewayOrderId?: string | null;
4860
4943
  /**
4861
- * @minLength 1
4862
- * @maxLength 100
4944
+ * Whether to delay capture of the payment.
4945
+ * Default: false
4946
+ * @deprecated Whether to delay capture of the payment.
4947
+ * Default: false
4948
+ * @replacedBy delayed_capture_settings.scheduled_action
4949
+ * @targetRemovalDate 2024-09-30
4863
4950
  */
4864
- orderId?: string;
4865
- }
4866
- interface SendMerchantOrderReceivedNotificationResponse {
4867
- }
4868
- interface SendCancelRefundEmailRequest {
4951
+ delayedCapture?: boolean;
4869
4952
  /**
4870
- * The ID of order that is canceled/refunded
4871
- * @minLength 1
4872
- * @maxLength 100
4953
+ * Specifies whether payment collection is initiated by Merchant or User of User
4954
+ * Default: `true`
4955
+ * @internal
4873
4956
  */
4874
- orderId?: string;
4957
+ merchantInitiated?: boolean | null;
4875
4958
  /**
4876
- * Personal note added to the email (optional)
4877
- * @minLength 1
4878
- * @maxLength 1000
4959
+ * Redirect urls which are used to return buyer to third party system.
4960
+ * @internal
4879
4961
  */
4880
- customMessage?: string | null;
4881
- /** Refund amount */
4882
- refundAmount?: Price;
4962
+ redirectUrls?: RedirectUrls;
4963
+ /** Delayed capture payment settings */
4964
+ delayedCaptureSettings?: DelayedCaptureSettings;
4965
+ }
4966
+ interface RedirectUrls {
4883
4967
  /**
4884
- * Refund ID. (Optional)
4885
- * @format GUID
4968
+ * URL to redirect buyer in case of approved (successful) transaction
4969
+ * @format WEB_URL
4886
4970
  */
4887
- refundId?: string | null;
4888
- }
4889
- interface SendCancelRefundEmailResponse {
4890
- }
4891
- interface SendRefundEmailRequest {
4971
+ successUrl?: string | null;
4892
4972
  /**
4893
- * The ID of order that is refunded
4894
- * @format GUID
4973
+ * URL to redirect buyer in case of buyer canceled the transaction
4974
+ * @format WEB_URL
4895
4975
  */
4896
- orderId?: string;
4976
+ cancelUrl?: string | null;
4897
4977
  /**
4898
- * Refund ID
4899
- * @format GUID
4978
+ * URL to redirect buyer in case of failed/rejected transaction
4979
+ * @format WEB_URL
4900
4980
  */
4901
- refundId?: string;
4981
+ errorUrl?: string | null;
4902
4982
  /**
4903
- * Personal note added to the email (optional)
4904
- * @minLength 1
4905
- * @maxLength 1000
4983
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4984
+ * @format WEB_URL
4906
4985
  */
4907
- customMessage?: string | null;
4908
- }
4909
- interface SendRefundEmailResponse {
4986
+ pendingUrl?: string | null;
4910
4987
  }
4911
- interface SendFulfillmentEmailRequest {
4912
- /** @format GUID */
4913
- orderId?: string;
4914
- /** @format GUID */
4915
- fulfillerId?: string;
4988
+ interface DelayedCaptureSettings {
4989
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4990
+ scheduledAction?: ScheduledActionWithLiterals;
4991
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4992
+ delayDuration?: Duration;
4916
4993
  }
4917
- interface SendFulfillmentEmailResponse {
4994
+ declare enum ScheduledAction {
4995
+ /** Whether payment will be auto-voided when duration passes */
4996
+ VOID = "VOID",
4997
+ /** Whether payment will be auto-captured when duration passes */
4998
+ CAPTURE = "CAPTURE"
4918
4999
  }
4919
- interface SendMerchantOrderReceivedPushRequest {
5000
+ /** @enumType */
5001
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5002
+ interface Duration {
4920
5003
  /**
4921
- * @minLength 1
4922
- * @maxLength 100
5004
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5005
+ * @min 1
4923
5006
  */
4924
- orderId?: string;
4925
- }
4926
- interface SendMerchantOrderReceivedPushResponse {
4927
- }
4928
- interface PreviewEmailByTypeRequest {
4929
- emailType?: PreviewEmailTypeWithLiterals;
5007
+ count?: number;
5008
+ /** Duration unit: MINUTES, HOURS and DAYS */
5009
+ unit?: DurationUnitWithLiterals;
4930
5010
  }
4931
- declare enum PreviewEmailType {
4932
- ORDER_PLACED = "ORDER_PLACED",
4933
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4934
- ORDER_SHIPPED = "ORDER_SHIPPED",
4935
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5011
+ declare enum DurationUnit {
5012
+ MINUTES = "MINUTES",
5013
+ HOURS = "HOURS",
5014
+ DAYS = "DAYS"
4936
5015
  }
4937
5016
  /** @enumType */
4938
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4939
- interface PreviewEmailByTypeResponse {
4940
- emailPreview?: string;
5017
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5018
+ interface PreparePaymentCollectionResponse {
5019
+ /** Payment gateway order id which is associated with given payment */
5020
+ paymentGatewayOrderId?: string;
4941
5021
  }
4942
- interface PreviewRefundEmailRequest {
5022
+ interface GetPaymentCollectabilityStatusRequest {
4943
5023
  /**
5024
+ * Ecom order ID.
4944
5025
  * @minLength 1
4945
5026
  * @maxLength 100
4946
5027
  */
4947
- orderId?: string;
4948
- /** Refund amount */
4949
- refundAmount?: Price;
4950
- /** Refund business details */
4951
- details?: RefundDetails;
5028
+ ecomOrderId: string;
5029
+ }
5030
+ interface GetPaymentCollectabilityStatusResponse {
5031
+ /** Payment collectability status */
5032
+ status?: PaymentCollectabilityStatusWithLiterals;
5033
+ /** Collectable order amount */
5034
+ amount?: Price;
4952
5035
  /**
4953
- * Personal note added to the email (optional)
4954
- * @minLength 1
4955
- * @maxLength 1000
5036
+ * Whether authorization supported
5037
+ * @internal
4956
5038
  */
4957
- customMessage?: string | null;
5039
+ authorizationSupported?: boolean;
4958
5040
  /**
4959
- * Refund ID. (Optional)
4960
- * @format GUID
5041
+ * Whether custom amount is supported for payment collection
5042
+ * @internal
4961
5043
  */
4962
- refundId?: string | null;
5044
+ customAmountSupported?: boolean;
4963
5045
  }
4964
- /** Business model of a refund request */
4965
- interface RefundDetails {
4966
- /**
4967
- * Order line item IDs and quantities that were refunded.
4968
- * @maxSize 300
4969
- */
4970
- items?: RefundItem[];
4971
- /** Whether the shipping fee was also refunded. */
4972
- shippingIncluded?: boolean;
4973
- /**
4974
- * Reason for the refund, provided by customer (optional).
4975
- * @maxLength 200
4976
- */
4977
- reason?: string | null;
4978
- /**
4979
- * Line items that were refunded.
4980
- * @maxSize 300
4981
- */
4982
- lineItems?: LineItemRefund[];
4983
- /**
4984
- * Additional fees that were refunded.
4985
- * @maxSize 100
4986
- */
4987
- additionalFees?: AdditionalFeeRefund[];
4988
- /** Shipping amount that was refunded. */
4989
- shipping?: ShippingRefund;
5046
+ declare enum PaymentCollectabilityStatus {
5047
+ UNKNOWN = "UNKNOWN",
5048
+ COLLECTABLE = "COLLECTABLE",
5049
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5050
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5051
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5052
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5053
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5054
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5055
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5056
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5057
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5058
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5059
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4990
5060
  }
4991
- interface RefundItem {
5061
+ /** @enumType */
5062
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
5063
+ interface RecordManuallyCollectedPaymentRequest {
4992
5064
  /**
4993
- * Line item ID the refunded line item.
4994
- * @format GUID
5065
+ * Order ID.
5066
+ * @minLength 1
5067
+ * @maxLength 100
4995
5068
  */
4996
- lineItemId?: string;
5069
+ orderId: string;
5070
+ /** Amount to be recorded as approved manual payment for given order */
5071
+ amount: Price;
4997
5072
  /**
4998
- * Line item quantity refunded.
4999
- * @min 1
5000
- * @max 100000
5073
+ * Payment method name provided by user.
5074
+ *
5075
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5076
+ * @internal
5001
5077
  */
5002
- quantity?: number;
5078
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5003
5079
  }
5004
- interface LineItemRefund {
5005
- /**
5006
- * Line item ID.
5007
- * @format GUID
5008
- * @immutable
5009
- */
5010
- lineItemId?: string;
5080
+ /**
5081
+ * User-defined payment method name.
5082
+ * Allows specifying either a predefined type or a custom name.
5083
+ */
5084
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5085
+ /** Predefined payment method. */
5086
+ predefined?: PredefinedPaymentMethodWithLiterals;
5011
5087
  /**
5012
- * Refund quantity.
5013
- * @min 1
5014
- * @max 100000
5015
- * @immutable
5088
+ * Custom payment method name provided by user.
5089
+ *
5090
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5091
+ * @minLength 1
5092
+ * @maxLength 150
5016
5093
  */
5017
- quantity?: number;
5094
+ custom?: string | null;
5018
5095
  }
5019
- interface AdditionalFeeRefund {
5020
- /**
5021
- * Additional fee ID.
5022
- * @format GUID
5023
- * @immutable
5024
- */
5025
- additionalFeeId?: string;
5096
+ /** @oneof */
5097
+ interface UserDefinedPaymentMethodNameKindOneOf {
5098
+ /** Predefined payment method. */
5099
+ predefined?: PredefinedPaymentMethodWithLiterals;
5026
5100
  /**
5027
- * Refund amount.
5028
- * @immutable
5101
+ * Custom payment method name provided by user.
5102
+ *
5103
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5104
+ * @minLength 1
5105
+ * @maxLength 150
5029
5106
  */
5030
- amount?: Price;
5107
+ custom?: string | null;
5031
5108
  }
5032
- interface ShippingRefund {
5033
- /**
5034
- * Refund amount.
5035
- * @immutable
5036
- */
5037
- amount?: Price;
5109
+ /** Predefined payment method types for offline/manual payments. */
5110
+ declare enum PredefinedPaymentMethod {
5111
+ /** Cash payment. */
5112
+ CASH = "CASH",
5113
+ /** Bank transfer. */
5114
+ BANK_TRANSFER = "BANK_TRANSFER",
5115
+ /** Payment by check. */
5116
+ CHECK = "CHECK"
5038
5117
  }
5039
- interface PreviewRefundEmailResponse {
5040
- emailPreview?: string;
5118
+ /** @enumType */
5119
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5120
+ interface RecordManuallyCollectedPaymentResponse {
5041
5121
  }
5042
- interface PreviewCancelEmailRequest {
5122
+ interface MarkOrderAsPaidRequest {
5043
5123
  /**
5124
+ * Ecom order ID.
5044
5125
  * @minLength 1
5045
5126
  * @maxLength 100
5046
5127
  */
5047
- orderId?: string;
5128
+ ecomOrderId: string;
5048
5129
  /**
5049
- * Personal note added to the email (optional)
5050
- * @minLength 1
5051
- * @maxLength 1000
5130
+ * Payment method name provided by user.
5131
+ *
5132
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5133
+ * @internal
5052
5134
  */
5053
- customMessage?: string | null;
5135
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5054
5136
  }
5055
- interface PreviewCancelEmailResponse {
5056
- emailPreview?: string;
5137
+ interface MarkOrderAsPaidResponse {
5138
+ /** Updated order. */
5139
+ order?: Order;
5057
5140
  }
5058
- interface PreviewCancelRefundEmailRequest {
5141
+ interface BulkMarkOrdersAsPaidRequest {
5059
5142
  /**
5143
+ * IDs of orders to mark as paid.
5144
+ * @minSize 1
5145
+ * @maxSize 100
5060
5146
  * @minLength 1
5061
5147
  * @maxLength 100
5062
5148
  */
5063
- orderId?: string;
5149
+ ecomOrderIds: string[];
5150
+ }
5151
+ interface BulkMarkOrdersAsPaidResponse {
5064
5152
  /**
5065
- * Personal note added to the email (optional)
5066
- * @minLength 1
5067
- * @maxLength 1000
5153
+ * Items updated by the bulk action.
5154
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5068
5155
  */
5069
- customMessage?: string | null;
5070
- /** Refund amount */
5071
- refundAmount?: Price;
5156
+ results?: BulkOrderResult[];
5157
+ /** Bulk action metadata. */
5158
+ bulkActionMetadata?: BulkActionMetadata;
5159
+ }
5160
+ interface BulkOrderResult {
5161
+ /** Item metadata. */
5162
+ itemMetadata?: ItemMetadata;
5072
5163
  /**
5073
- * Refund ID. (Optional)
5074
- * @format GUID
5164
+ * Updated order.
5165
+ *
5166
+ * Returned when `returnFullEntity = true`.
5075
5167
  */
5076
- refundId?: string | null;
5077
- }
5078
- interface PreviewCancelRefundEmailResponse {
5079
- emailPreview?: string;
5080
- }
5081
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5168
+ item?: Order;
5082
5169
  }
5083
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5084
- emailPreview?: string;
5170
+ interface ItemMetadata {
5171
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5172
+ id?: string | null;
5173
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5174
+ originalIndex?: number;
5175
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5176
+ success?: boolean;
5177
+ /** Details about the error in case of failure. */
5178
+ error?: ApplicationError;
5085
5179
  }
5086
- interface PreviewBuyerConfirmationEmailRequest {
5180
+ interface ApplicationError {
5181
+ /** Error code. */
5182
+ code?: string;
5183
+ /** Description of the error. */
5184
+ description?: string;
5185
+ /** Data related to the error. */
5186
+ data?: Record<string, any> | null;
5087
5187
  }
5088
- interface PreviewBuyerConfirmationEmailResponse {
5089
- emailPreview?: string;
5188
+ interface BulkActionMetadata {
5189
+ /** Number of items that were successfully processed. */
5190
+ totalSuccesses?: number;
5191
+ /** Number of items that couldn't be processed. */
5192
+ totalFailures?: number;
5193
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5194
+ undetailedFailures?: number;
5090
5195
  }
5091
- interface PreviewBuyerPickupConfirmationEmailRequest {
5196
+ interface GetRefundabilityStatusRequest {
5197
+ /**
5198
+ * Order ID.
5199
+ * @minLength 1
5200
+ * @maxLength 100
5201
+ */
5202
+ ecomOrderId: string;
5092
5203
  }
5093
- interface PreviewBuyerPickupConfirmationEmailResponse {
5094
- emailPreview?: string;
5204
+ interface GetRefundabilityStatusResponse {
5205
+ /**
5206
+ * Refundability details.
5207
+ * @maxSize 300
5208
+ */
5209
+ refundabilities?: Refundability[];
5210
+ /**
5211
+ * Whether the order supports refunding per item.
5212
+ * @deprecated
5213
+ */
5214
+ refundablePerItem?: boolean;
5095
5215
  }
5096
- interface PreviewShippingConfirmationEmailRequest {
5216
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5217
+ /** Reason why payment is not refundable. */
5218
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5219
+ /** Reason why payment is only refundable manually. */
5220
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5221
+ /** Payment ID. */
5222
+ paymentId?: string;
5223
+ /** Payment refundability status. */
5224
+ refundabilityStatus?: RefundableStatusWithLiterals;
5225
+ /** Link to payment provider dashboard. */
5226
+ providerLink?: string | null;
5097
5227
  }
5098
- interface PreviewShippingConfirmationEmailResponse {
5099
- emailPreview?: string;
5228
+ /** @oneof */
5229
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5230
+ /** Reason why payment is not refundable. */
5231
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5232
+ /** Reason why payment is only refundable manually. */
5233
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5100
5234
  }
5101
- interface PreviewResendDownloadLinksEmailRequest {
5235
+ declare enum RefundableStatus {
5236
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5237
+ MANUAL = "MANUAL",
5238
+ REFUNDABLE = "REFUNDABLE"
5102
5239
  }
5103
- interface PreviewResendDownloadLinksEmailResponse {
5104
- emailPreview?: string;
5240
+ /** @enumType */
5241
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5242
+ declare enum NonRefundableReason {
5243
+ NONE = "NONE",
5244
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5245
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5246
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5247
+ NOT_PAID = "NOT_PAID",
5248
+ ACCESS_DENIED = "ACCESS_DENIED",
5249
+ ZERO_PRICE = "ZERO_PRICE",
5250
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5251
+ PENDING_REFUND = "PENDING_REFUND",
5252
+ FORBIDDEN = "FORBIDDEN",
5253
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5254
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5255
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5105
5256
  }
5106
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5107
- /** Emitted on a meta site creation. */
5108
- siteCreated?: SiteCreated;
5109
- /** Emitted on a meta site transfer completion. */
5110
- siteTransferred?: SiteTransferred;
5111
- /** Emitted on a meta site deletion. */
5112
- siteDeleted?: SiteDeleted;
5113
- /** Emitted on a meta site restoration. */
5114
- siteUndeleted?: SiteUndeleted;
5115
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5116
- sitePublished?: SitePublished;
5117
- /** Emitted on a meta site unpublish. */
5118
- siteUnpublished?: SiteUnpublished;
5119
- /** Emitted when meta site is marked as template. */
5120
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5121
- /** Emitted when meta site is marked as a WixSite. */
5122
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5123
- /** Emitted when an application is provisioned (installed). */
5124
- serviceProvisioned?: ServiceProvisioned;
5125
- /** Emitted when an application is removed (uninstalled). */
5126
- serviceRemoved?: ServiceRemoved;
5127
- /** Emitted when meta site name (URL slug) is changed. */
5128
- siteRenamedPayload?: SiteRenamed;
5129
- /** Emitted when meta site was permanently deleted. */
5130
- hardDeleted?: SiteHardDeleted;
5131
- /** Emitted on a namespace change. */
5132
- namespaceChanged?: NamespaceChanged;
5133
- /** Emitted when Studio is attached. */
5134
- studioAssigned?: StudioAssigned;
5135
- /** Emitted when Studio is detached. */
5136
- studioUnassigned?: StudioUnassigned;
5137
- /**
5138
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5139
- * the actual URL.
5140
- *
5141
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5142
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5143
- */
5144
- urlChanged?: SiteUrlChanged;
5145
- /** Site is marked as PurgedExternally */
5146
- sitePurgedExternally?: SitePurgedExternally;
5147
- /** Emitted when Odeditor is attached. */
5148
- odeditorAssigned?: OdeditorAssigned;
5149
- /** Emitted when Odeditor is detached. */
5150
- odeditorUnassigned?: OdeditorUnassigned;
5151
- /** Emitted when Picasso is attached. */
5152
- picassoAssigned?: PicassoAssigned;
5153
- /** Emitted when Picasso is detached. */
5154
- picassoUnassigned?: PicassoUnassigned;
5155
- /** Emitted when Wixel is attached. */
5156
- wixelAssigned?: WixelAssigned;
5157
- /** Emitted when Wixel is detached. */
5158
- wixelUnassigned?: WixelUnassigned;
5159
- /** Emitted when StudioTwo is attached. */
5160
- studioTwoAssigned?: StudioTwoAssigned;
5161
- /** Emitted when StudioTwo is detached. */
5162
- studioTwoUnassigned?: StudioTwoUnassigned;
5163
- /** Emitted when media from user domain is enabled. */
5164
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5165
- /** Emitted when media from user domain is disabled. */
5166
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5167
- /** Emitted when Editorless is attached. */
5168
- editorlessAssigned?: EditorlessAssigned;
5169
- /** Emitted when Editorless is detached. */
5170
- editorlessUnassigned?: EditorlessUnassigned;
5171
- /**
5172
- * A meta site id.
5173
- * @format GUID
5174
- */
5175
- metaSiteId?: string;
5176
- /** A meta site version. Monotonically increasing. */
5177
- version?: string;
5178
- /** A timestamp of the event. */
5179
- timestamp?: string;
5257
+ /** @enumType */
5258
+ type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
5259
+ declare enum ManuallyRefundableReason {
5260
+ EXPIRED = "EXPIRED",
5261
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5262
+ OFFLINE = "OFFLINE",
5263
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5264
+ }
5265
+ /** @enumType */
5266
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5267
+ interface CreatePaymentGatewayOrderRequest {
5180
5268
  /**
5181
- * TODO(meta-site): Change validation once validations are disabled for consumers
5182
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5183
- * @maxSize 4000
5269
+ * Ecom order ID.
5270
+ * @minLength 1
5271
+ * @maxLength 100
5184
5272
  */
5185
- assets?: Asset[];
5186
- }
5187
- /** @oneof */
5188
- interface MetaSiteSpecialEventPayloadOneOf {
5189
- /** Emitted on a meta site creation. */
5190
- siteCreated?: SiteCreated;
5191
- /** Emitted on a meta site transfer completion. */
5192
- siteTransferred?: SiteTransferred;
5193
- /** Emitted on a meta site deletion. */
5194
- siteDeleted?: SiteDeleted;
5195
- /** Emitted on a meta site restoration. */
5196
- siteUndeleted?: SiteUndeleted;
5197
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5198
- sitePublished?: SitePublished;
5199
- /** Emitted on a meta site unpublish. */
5200
- siteUnpublished?: SiteUnpublished;
5201
- /** Emitted when meta site is marked as template. */
5202
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5203
- /** Emitted when meta site is marked as a WixSite. */
5204
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5205
- /** Emitted when an application is provisioned (installed). */
5206
- serviceProvisioned?: ServiceProvisioned;
5207
- /** Emitted when an application is removed (uninstalled). */
5208
- serviceRemoved?: ServiceRemoved;
5209
- /** Emitted when meta site name (URL slug) is changed. */
5210
- siteRenamedPayload?: SiteRenamed;
5211
- /** Emitted when meta site was permanently deleted. */
5212
- hardDeleted?: SiteHardDeleted;
5213
- /** Emitted on a namespace change. */
5214
- namespaceChanged?: NamespaceChanged;
5215
- /** Emitted when Studio is attached. */
5216
- studioAssigned?: StudioAssigned;
5217
- /** Emitted when Studio is detached. */
5218
- studioUnassigned?: StudioUnassigned;
5273
+ ecomOrderId: string;
5274
+ /** Information about the user who initiated the payment. */
5275
+ chargedBy?: ChargedBy;
5219
5276
  /**
5220
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5221
- * the actual URL.
5277
+ * Whether to delay capture of the payment.
5222
5278
  *
5223
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5224
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5279
+ * Default: false
5280
+ * @internal
5225
5281
  */
5226
- urlChanged?: SiteUrlChanged;
5227
- /** Site is marked as PurgedExternally */
5228
- sitePurgedExternally?: SitePurgedExternally;
5229
- /** Emitted when Odeditor is attached. */
5230
- odeditorAssigned?: OdeditorAssigned;
5231
- /** Emitted when Odeditor is detached. */
5232
- odeditorUnassigned?: OdeditorUnassigned;
5233
- /** Emitted when Picasso is attached. */
5234
- picassoAssigned?: PicassoAssigned;
5235
- /** Emitted when Picasso is detached. */
5236
- picassoUnassigned?: PicassoUnassigned;
5237
- /** Emitted when Wixel is attached. */
5238
- wixelAssigned?: WixelAssigned;
5239
- /** Emitted when Wixel is detached. */
5240
- wixelUnassigned?: WixelUnassigned;
5241
- /** Emitted when StudioTwo is attached. */
5242
- studioTwoAssigned?: StudioTwoAssigned;
5243
- /** Emitted when StudioTwo is detached. */
5244
- studioTwoUnassigned?: StudioTwoUnassigned;
5245
- /** Emitted when media from user domain is enabled. */
5246
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5247
- /** Emitted when media from user domain is disabled. */
5248
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5249
- /** Emitted when Editorless is attached. */
5250
- editorlessAssigned?: EditorlessAssigned;
5251
- /** Emitted when Editorless is detached. */
5252
- editorlessUnassigned?: EditorlessUnassigned;
5282
+ delayedCapture?: boolean;
5253
5283
  }
5254
- interface Asset {
5284
+ interface ChargedBy {
5255
5285
  /**
5256
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5257
- * @maxLength 36
5286
+ * ID - id of the user who initiated the payment
5287
+ * @format GUID
5258
5288
  */
5259
- appDefId?: string;
5289
+ id?: string;
5260
5290
  /**
5261
- * An instance id. For legacy reasons may be UUID or a string.
5291
+ * Full name - name of the user who initiated the payment
5292
+ * @minLength 1
5262
5293
  * @maxLength 200
5263
5294
  */
5264
- instanceId?: string;
5265
- /** An application state. */
5266
- state?: StateWithLiterals;
5295
+ fullName?: string | null;
5267
5296
  }
5268
- declare enum State {
5269
- UNKNOWN = "UNKNOWN",
5270
- ENABLED = "ENABLED",
5271
- DISABLED = "DISABLED",
5272
- PENDING = "PENDING",
5273
- DEMO = "DEMO"
5297
+ interface CreatePaymentGatewayOrderResponse {
5298
+ /** ID of the order created in the payment gateway */
5299
+ paymentGatewayOrderId?: string;
5274
5300
  }
5275
- /** @enumType */
5276
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5277
- interface SiteCreated {
5278
- /**
5279
- * A template identifier (empty if not created from a template).
5280
- * @maxLength 36
5281
- */
5282
- originTemplateId?: string;
5301
+ interface ChargeMembershipsRequest {
5283
5302
  /**
5284
- * An account id of the owner.
5285
- * @format GUID
5303
+ * Order ID.
5304
+ * @minLength 1
5305
+ * @maxLength 100
5286
5306
  */
5287
- ownerId?: string;
5288
- /** A context in which meta site was created. */
5289
- context?: SiteCreatedContextWithLiterals;
5307
+ ecomOrderId: string;
5290
5308
  /**
5291
- * A meta site id from which this site was created.
5292
- *
5293
- * In case of a creation from a template it's a template id.
5294
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5309
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5310
+ * but a user which is using the membership on behalf of the a member
5295
5311
  * @format GUID
5296
5312
  */
5297
- originMetaSiteId?: string | null;
5313
+ memberId: string;
5298
5314
  /**
5299
- * A meta site name (URL slug).
5300
- * @maxLength 20
5315
+ * List of items to be paid by memberships
5316
+ * @minSize 1
5317
+ * @maxSize 300
5301
5318
  */
5302
- siteName?: string;
5303
- /** A namespace. */
5304
- namespace?: NamespaceWithLiterals;
5305
- }
5306
- declare enum SiteCreatedContext {
5307
- /** A valid option, we don't expose all reasons why site might be created. */
5308
- OTHER = "OTHER",
5309
- /** A meta site was created from template. */
5310
- FROM_TEMPLATE = "FROM_TEMPLATE",
5311
- /** A meta site was created by copying of the transfferred meta site. */
5312
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5313
- /** A copy of existing meta site. */
5314
- DUPLICATE = "DUPLICATE",
5315
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5316
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5317
- /** deprecated A meta site was created for Flash editor. */
5318
- FLASH = "FLASH"
5319
+ membershipCharges?: MembershipChargeItem[];
5319
5320
  }
5320
- /** @enumType */
5321
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5322
- declare enum Namespace {
5323
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5324
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5325
- WIX = "WIX",
5326
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5327
- SHOUT_OUT = "SHOUT_OUT",
5328
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5329
- ALBUMS = "ALBUMS",
5330
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5331
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5332
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5333
- HOTELS = "HOTELS",
5334
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5335
- CLUBS = "CLUBS",
5336
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5337
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5321
+ interface MembershipChargeItem {
5338
5322
  /**
5339
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5340
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5323
+ * The id of used membership
5324
+ * @minLength 1
5325
+ * @maxLength 100
5341
5326
  */
5342
- DEV_SITE = "DEV_SITE",
5343
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5344
- LOGOS = "LOGOS",
5345
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5346
- VIDEO_MAKER = "VIDEO_MAKER",
5347
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5348
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5349
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5350
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5327
+ membershipId?: string;
5351
5328
  /**
5352
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5353
- *
5354
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5329
+ * ID of the application providing this payment option
5330
+ * @format GUID
5355
5331
  */
5356
- HTML_DRAFT = "HTML_DRAFT",
5332
+ appId?: string;
5333
+ /** The name of used membership */
5334
+ membershipName?: MembershipName;
5335
+ /** Additional data about this membership */
5336
+ membershipAdditionalData?: Record<string, any> | null;
5337
+ /** Catalog and item reference info. */
5338
+ catalogReference?: CatalogReference;
5339
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5340
+ serviceProperties?: ServiceProperties;
5357
5341
  /**
5358
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5359
- * Will be accessible from Site List and will not have a website app.
5360
- * Once the user attaches a site, the site will become a regular wixsite.
5342
+ * Usually would be the same as catalogReference.catalogItemId
5343
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5344
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5345
+ * @minLength 1
5346
+ * @maxLength 36
5361
5347
  */
5362
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5363
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5364
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5365
- /** It is to be used in the Business First efforts. */
5366
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5367
- /** Bookings business flow with no site. */
5368
- ANYWHERE = "ANYWHERE",
5369
- /** Namespace for Headless Backoffice with no editor */
5370
- HEADLESS = "HEADLESS",
5371
- /**
5372
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5373
- * The site will be used for account level CSM feature for enterprise
5348
+ rootCatalogItemId?: string | null;
5349
+ /**
5350
+ * line item id of Checkout/Order line item
5351
+ * @minLength 1
5352
+ * @maxLength 100
5374
5353
  */
5375
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5376
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5377
- RISE = "RISE",
5354
+ lineItemId?: string;
5355
+ }
5356
+ interface MembershipName {
5378
5357
  /**
5379
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5380
- * There's a blank site behind the scene but it's blank).
5381
- * The Mobile company will be the owner of this namespace.
5358
+ * Membership name in the site's original language.
5359
+ * @maxLength 100
5382
5360
  */
5383
- BRANDED_FIRST = "BRANDED_FIRST",
5384
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5385
- NOWNIA = "NOWNIA",
5361
+ original?: string;
5386
5362
  /**
5387
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5388
- * The Partners company owns this namespace.
5363
+ * Membership name translated into the buyer's language.
5364
+ *
5365
+ * Default: The value of `original`
5366
+ * @maxLength 100
5389
5367
  */
5390
- UGC_TEMPLATE = "UGC_TEMPLATE",
5391
- /** Codux Headless Sites */
5392
- CODUX = "CODUX",
5393
- /** Bobb - AI Design Creator. */
5394
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5368
+ translated?: string | null;
5369
+ }
5370
+ interface ChargeMembershipsResponse {
5371
+ }
5372
+ interface TriggerRefundRequest {
5395
5373
  /**
5396
- * Shared Blog Site is a unique single site across Enterprise account,
5397
- * This site will hold all Blog posts related to the Marketing product.
5374
+ * The order this refund related to
5375
+ * @minLength 1
5376
+ * @maxLength 100
5398
5377
  */
5399
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5400
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5401
- STANDALONE_FORMS = "STANDALONE_FORMS",
5402
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5403
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5404
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5405
- MIMIR = "MIMIR",
5406
- /** Wix Twins platform. */
5407
- TWINS = "TWINS",
5408
- /** Wix Nano. */
5409
- NANO = "NANO",
5410
- /** Base44 headless sites. */
5411
- BASE44 = "BASE44",
5412
- /** Wix Channels Sites */
5413
- CHANNELS = "CHANNELS",
5414
- /** Nautilus platform. */
5415
- NAUTILUS = "NAUTILUS",
5378
+ ecomOrderId: string;
5416
5379
  /**
5417
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5418
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5380
+ * Refund operations information
5381
+ * @minSize 1
5382
+ * @maxSize 1
5419
5383
  */
5420
- SYMPHONY = "SYMPHONY",
5421
- /** Nautilus platform app. */
5422
- NAUTILUS_APPS = "NAUTILUS_APPS",
5384
+ payments: PaymentRefund[];
5385
+ /** Business model of a refund */
5386
+ details?: RefundDetails;
5387
+ /** Side effect details related to refund */
5388
+ sideEffects?: RefundSideEffects;
5389
+ }
5390
+ interface PaymentRefund {
5423
5391
  /**
5424
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5425
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5392
+ * Specific payment within the order to refund
5393
+ * @format GUID
5426
5394
  */
5427
- VIBU = "VIBU",
5395
+ paymentId?: string;
5396
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5397
+ amount?: Price;
5428
5398
  /**
5429
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5430
- * (an Enterprise account may have several), holding that BrandKit's brand definition
5431
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5432
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
5399
+ * Whether refund is made externally and manually (on the payment provider's side)
5400
+ * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
5401
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5433
5402
  */
5434
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5403
+ externalRefund?: boolean;
5435
5404
  /**
5436
- * Dev-center development sites (com.wixpress.devcenter.dsm).
5437
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5405
+ * Gateway refund id. When param is present, new refund is not created.
5406
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5407
+ * and all side effects from request will be executed.
5408
+ * @internal
5409
+ * @minLength 1
5410
+ * @maxLength 100
5438
5411
  */
5439
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5412
+ gatewayRefundId?: string | null;
5440
5413
  }
5441
- /** @enumType */
5442
- type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
5443
- /** Site transferred to another user. */
5444
- interface SiteTransferred {
5414
+ /** Business model of a refund request */
5415
+ interface RefundDetails {
5445
5416
  /**
5446
- * A previous owner id (user that transfers meta site).
5447
- * @format GUID
5417
+ * Order line item IDs and quantities that were refunded.
5418
+ * @maxSize 300
5448
5419
  */
5449
- oldOwnerId?: string;
5420
+ items?: RefundItem[];
5421
+ /** Whether the shipping fee was also refunded. */
5422
+ shippingIncluded?: boolean;
5450
5423
  /**
5451
- * A new owner id (user that accepts meta site).
5452
- * @format GUID
5424
+ * Reason for the refund, provided by customer (optional).
5425
+ * @maxLength 200
5453
5426
  */
5454
- newOwnerId?: string;
5455
- }
5456
- /** Soft deletion of the meta site. Could be restored. */
5457
- interface SiteDeleted {
5458
- /** A deletion context. */
5459
- deleteContext?: DeleteContext;
5460
- }
5461
- interface DeleteContext {
5462
- /** When the meta site was deleted. */
5463
- dateDeleted?: Date | null;
5464
- /** A status. */
5465
- deleteStatus?: DeleteStatusWithLiterals;
5427
+ reason?: string | null;
5466
5428
  /**
5467
- * A reason (flow).
5468
- * @maxLength 255
5429
+ * Line items that were refunded.
5430
+ * @maxSize 300
5469
5431
  */
5470
- deleteOrigin?: string;
5432
+ lineItems?: LineItemRefund[];
5471
5433
  /**
5472
- * A service that deleted it.
5473
- * @maxLength 255
5434
+ * Additional fees that were refunded.
5435
+ * @maxSize 100
5474
5436
  */
5475
- initiatorId?: string | null;
5476
- }
5477
- declare enum DeleteStatus {
5478
- UNKNOWN = "UNKNOWN",
5479
- TRASH = "TRASH",
5480
- DELETED = "DELETED",
5481
- PENDING_PURGE = "PENDING_PURGE",
5482
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5483
- }
5484
- /** @enumType */
5485
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5486
- /** Restoration of the meta site. */
5487
- interface SiteUndeleted {
5488
- }
5489
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5490
- interface SitePublished {
5437
+ additionalFees?: AdditionalFeeRefund[];
5438
+ /** Shipping amount that was refunded. */
5439
+ shipping?: ShippingRefund;
5491
5440
  }
5492
- interface SiteUnpublished {
5441
+ interface RefundItem {
5493
5442
  /**
5494
- * A list of URLs previously associated with the meta site.
5495
- * @maxLength 4000
5496
- * @maxSize 10000
5443
+ * Line item ID the refunded line item.
5444
+ * @format GUID
5497
5445
  */
5498
- urls?: string[];
5499
- }
5500
- interface SiteMarkedAsTemplate {
5501
- }
5502
- interface SiteMarkedAsWixSite {
5446
+ lineItemId?: string;
5447
+ /**
5448
+ * Line item quantity refunded.
5449
+ * @min 1
5450
+ * @max 100000
5451
+ */
5452
+ quantity?: number;
5503
5453
  }
5504
- /**
5505
- * Represents a service provisioned a site.
5506
- *
5507
- * Note on `origin_instance_id`:
5508
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5509
- * This is because of the following scenario:
5510
- *
5511
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5512
- * such as a product catalog. When you create a site from this template, you inherit this
5513
- * default product catalog. However, if the template's product catalog is modified,
5514
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5515
- * your site remains consistent with what you initially received and does not include any
5516
- * changes made to the original template afterward.
5517
- * To ensure this, the TPA on the template gets a new instance_id.
5518
- */
5519
- interface ServiceProvisioned {
5454
+ interface LineItemRefund {
5520
5455
  /**
5521
- * Either UUID or EmbeddedServiceType.
5522
- * @maxLength 36
5456
+ * Line item ID.
5457
+ * @format GUID
5458
+ * @immutable
5523
5459
  */
5524
- appDefId?: string;
5460
+ lineItemId?: string;
5525
5461
  /**
5526
- * Not only UUID. Something here could be something weird.
5527
- * @maxLength 36
5462
+ * Refund quantity.
5463
+ * @min 1
5464
+ * @max 100000
5465
+ * @immutable
5528
5466
  */
5529
- instanceId?: string;
5467
+ quantity?: number;
5468
+ }
5469
+ interface AdditionalFeeRefund {
5530
5470
  /**
5531
- * An instance id from which this instance is originated.
5532
- * @maxLength 36
5471
+ * Additional fee ID.
5472
+ * @format GUID
5473
+ * @immutable
5533
5474
  */
5534
- originInstanceId?: string;
5475
+ additionalFeeId?: string;
5535
5476
  /**
5536
- * A version.
5537
- * @maxLength 500
5477
+ * Refund amount.
5478
+ * @immutable
5538
5479
  */
5539
- version?: string | null;
5480
+ amount?: Price;
5481
+ }
5482
+ interface ShippingRefund {
5540
5483
  /**
5541
- * The origin meta site id
5542
- * @format GUID
5484
+ * Refund amount.
5485
+ * @immutable
5543
5486
  */
5544
- originMetaSiteId?: string | null;
5487
+ amount?: Price;
5545
5488
  }
5546
- interface ServiceRemoved {
5489
+ interface RefundSideEffects {
5490
+ /** Inventory restock details as part of this refund. */
5491
+ restockInfo?: RestockInfo;
5492
+ /** Whether to send a refund confirmation email to the customer. */
5493
+ sendOrderRefundedEmail?: boolean;
5547
5494
  /**
5548
- * Either UUID or EmbeddedServiceType.
5549
- * @maxLength 36
5495
+ * Custom message added to the refund confirmation email.
5496
+ * @minLength 1
5497
+ * @maxLength 1000
5550
5498
  */
5551
- appDefId?: string;
5499
+ customMessage?: string | null;
5500
+ }
5501
+ interface RestockInfo {
5502
+ /** Restock type. */
5503
+ type?: RestockTypeWithLiterals;
5552
5504
  /**
5553
- * Not only UUID. Something here could be something weird.
5554
- * @maxLength 36
5505
+ * Deprecated, use items instead
5506
+ * @internal
5507
+ * @maxSize 300
5508
+ * @deprecated
5555
5509
  */
5556
- instanceId?: string;
5510
+ lineItemIds?: string[];
5557
5511
  /**
5558
- * A version.
5559
- * @maxLength 500
5512
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5513
+ * @maxSize 300
5560
5514
  */
5561
- version?: string | null;
5515
+ items?: RestockItem[];
5562
5516
  }
5563
- /** Rename of the site. Meaning, free public url has been changed as well. */
5564
- interface SiteRenamed {
5517
+ declare enum RestockType {
5518
+ NO_ITEMS = "NO_ITEMS",
5519
+ ALL_ITEMS = "ALL_ITEMS",
5520
+ SOME_ITEMS = "SOME_ITEMS"
5521
+ }
5522
+ /** @enumType */
5523
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5524
+ interface RestockItem {
5565
5525
  /**
5566
- * A new meta site name (URL slug).
5567
- * @maxLength 20
5526
+ * ID of the line item being restocked.
5527
+ * @format GUID
5568
5528
  */
5569
- newSiteName?: string;
5529
+ lineItemId?: string;
5570
5530
  /**
5571
- * A previous meta site name (URL slug).
5572
- * @maxLength 255
5531
+ * Line item quantity being restocked.
5532
+ * @min 1
5533
+ * @max 100000
5573
5534
  */
5574
- oldSiteName?: string;
5575
- }
5576
- /**
5577
- * Hard deletion of the meta site.
5578
- *
5579
- * Could not be restored. Therefore it's desirable to cleanup data.
5580
- */
5581
- interface SiteHardDeleted {
5582
- /** A deletion context. */
5583
- deleteContext?: DeleteContext;
5584
- }
5585
- interface NamespaceChanged {
5586
- /** A previous namespace. */
5587
- oldNamespace?: NamespaceWithLiterals;
5588
- /** A new namespace. */
5589
- newNamespace?: NamespaceWithLiterals;
5590
- }
5591
- /** Assigned Studio editor */
5592
- interface StudioAssigned {
5535
+ quantity?: number;
5536
+ /**
5537
+ * Per-location breakdown of restock quantities.
5538
+ * @internal
5539
+ * @maxSize 5
5540
+ */
5541
+ restockLocations?: RestockLocation[];
5593
5542
  }
5594
- /** Unassigned Studio editor */
5595
- interface StudioUnassigned {
5543
+ interface TriggerRefundResponse {
5544
+ /** All order's transactions after the refunds were added */
5545
+ orderTransactions?: OrderTransactions;
5546
+ /** Created refund ID */
5547
+ refundId?: string | null;
5548
+ /** Payment ID's that the refund execution had failed for */
5549
+ failedPaymentIds?: ItemMetadata[];
5596
5550
  }
5597
5551
  /**
5598
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5599
- *
5600
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5601
- * with sites and its urls, you need to listen to another topic/event. Read about it:
5552
+ * A record of all payments and refunds associated with an order.
5602
5553
  *
5603
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5604
- */
5605
- interface SiteUrlChanged {
5606
- }
5607
- /**
5608
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5609
- * Consumed by other teams to remove relevant data.
5554
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5610
5555
  */
5611
- interface SitePurgedExternally {
5612
- /**
5613
- * @maxLength 2048
5614
- * @maxSize 100
5615
- * @deprecated
5616
- * @targetRemovalDate 2025-04-15
5617
- */
5618
- appDefId?: string[];
5619
- }
5620
- /** Assigned Odeditor */
5621
- interface OdeditorAssigned {
5622
- }
5623
- /** Unassigned Odeditor */
5624
- interface OdeditorUnassigned {
5625
- }
5626
- /** Assigned Picasso editor */
5627
- interface PicassoAssigned {
5628
- }
5629
- /** Unassigned Picasso */
5630
- interface PicassoUnassigned {
5631
- }
5632
- /** Assigned Wixel */
5633
- interface WixelAssigned {
5634
- }
5635
- /** Unassigned Wixel */
5636
- interface WixelUnassigned {
5637
- }
5638
- /** Assigned StudioTwo */
5639
- interface StudioTwoAssigned {
5640
- }
5641
- /** Unassigned StudioTwo */
5642
- interface StudioTwoUnassigned {
5643
- }
5644
- /** Media from user domain is enabled. */
5645
- interface UserDomainMediaEnabled {
5646
- }
5647
- /** Media from user domain is disabled. */
5648
- interface UserDomainMediaDisabled {
5649
- }
5650
- /** Assigned Editorless */
5651
- interface EditorlessAssigned {
5652
- }
5653
- /** Unassigned Editorless */
5654
- interface EditorlessUnassigned {
5655
- }
5656
- interface HasCustomEmailConfigurationsRequest {
5657
- }
5658
- interface HasCustomEmailConfigurationsResponse {
5659
- hasCustomConfigurations?: boolean;
5660
- }
5661
- interface AddToAutomationMigrationPopulationRequest {
5662
- /** When true, sends custom email configurations to automation system via email */
5663
- sendCustomEmailConfigs?: boolean;
5664
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5665
- origin?: OriginWithLiterals;
5666
- }
5667
- declare enum Origin {
5668
- OPT_IN = "OPT_IN",
5669
- MIGRATION = "MIGRATION"
5670
- }
5671
- /** @enumType */
5672
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5673
- interface AddToAutomationMigrationPopulationResponse {
5674
- success?: boolean;
5675
- }
5676
- interface IsInAutomationMigrationPopulationRequest {
5677
- }
5678
- interface IsInAutomationMigrationPopulationResponse {
5679
- inPopulation?: boolean;
5680
- }
5681
- interface PreparePaymentCollectionRequest {
5556
+ interface OrderTransactions {
5682
5557
  /**
5683
- * Ecom order ID.
5684
- * @minLength 1
5685
- * @maxLength 100
5558
+ * Order ID.
5559
+ * @format GUID
5686
5560
  */
5687
- ecomOrderId: string;
5688
- /** Amount to collect */
5689
- amount: Price;
5561
+ orderId?: string;
5690
5562
  /**
5691
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5692
- * Existing payment gateway order will be updated with a new amount.
5693
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
5563
+ * Record of payments made to the merchant.
5564
+ * @maxSize 100
5694
5565
  */
5695
- paymentGatewayOrderId?: string | null;
5566
+ payments?: Payment[];
5696
5567
  /**
5697
- * Whether to delay capture of the payment.
5698
- * Default: false
5699
- * @deprecated Whether to delay capture of the payment.
5700
- * Default: false
5701
- * @replacedBy delayed_capture_settings.scheduled_action
5702
- * @targetRemovalDate 2024-09-30
5568
+ * Record of refunds made to the buyer.
5569
+ * @maxSize 300
5703
5570
  */
5704
- delayedCapture?: boolean;
5571
+ refunds?: Refund[];
5572
+ }
5573
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5574
+ /** Regular payment details. */
5575
+ regularPaymentDetails?: RegularPaymentDetails;
5576
+ /** Gift card payment details. */
5577
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5578
+ /** Membership payment details. */
5579
+ membershipPaymentDetails?: MembershipPaymentDetails;
5705
5580
  /**
5706
- * Specifies whether payment collection is initiated by Merchant or User of User
5707
- * Default: `true`
5581
+ * Receipt created by Wix
5708
5582
  * @internal
5709
5583
  */
5710
- merchantInitiated?: boolean | null;
5584
+ wixReceipt?: WixReceiptInfo;
5711
5585
  /**
5712
- * Redirect urls which are used to return buyer to third party system.
5586
+ * Receipt created by an external system.
5713
5587
  * @internal
5714
5588
  */
5715
- redirectUrls?: RedirectUrls;
5716
- /** Delayed capture payment settings */
5717
- delayedCaptureSettings?: DelayedCaptureSettings;
5718
- }
5719
- interface RedirectUrls {
5589
+ externalReceipt?: ExternalReceiptInfo;
5590
+ /** @internal */
5591
+ canceled?: CanceledStatusDetails;
5592
+ /** @internal */
5593
+ declined?: DeclinedStatusDetails;
5594
+ /** @internal */
5595
+ voided?: VoidedStatusDetails;
5720
5596
  /**
5721
- * URL to redirect buyer in case of approved (successful) transaction
5722
- * @format WEB_URL
5597
+ * Payment ID.
5598
+ * @format GUID
5599
+ * @readonly
5723
5600
  */
5724
- successUrl?: string | null;
5601
+ id?: string | null;
5602
+ /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
5603
+ createdDate?: Date | null;
5725
5604
  /**
5726
- * URL to redirect buyer in case of buyer canceled the transaction
5727
- * @format WEB_URL
5605
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5606
+ * @readonly
5728
5607
  */
5729
- cancelUrl?: string | null;
5608
+ updatedDate?: Date | null;
5609
+ /** Payment amount. */
5610
+ amount?: Price;
5730
5611
  /**
5731
- * URL to redirect buyer in case of failed/rejected transaction
5732
- * @format WEB_URL
5612
+ * Whether refunds for this payment are disabled.
5613
+ * + `true`: This payment is not refundable.
5614
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5733
5615
  */
5734
- errorUrl?: string | null;
5616
+ refundDisabled?: boolean;
5735
5617
  /**
5736
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
5737
- * @format WEB_URL
5618
+ * Whether receipt generation is allowed for this payment.
5619
+ * + `true`: This payment supports receipt generation.
5620
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5621
+ * @readonly
5738
5622
  */
5739
- pendingUrl?: string | null;
5740
- }
5741
- interface DelayedCaptureSettings {
5742
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5743
- scheduledAction?: ScheduledActionWithLiterals;
5744
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
5745
- delayDuration?: Duration;
5746
- }
5747
- declare enum ScheduledAction {
5748
- /** Whether payment will be auto-voided when duration passes */
5749
- VOID = "VOID",
5750
- /** Whether payment will be auto-captured when duration passes */
5751
- CAPTURE = "CAPTURE"
5752
- }
5753
- /** @enumType */
5754
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5755
- interface Duration {
5623
+ supportReceiptGeneration?: boolean;
5624
+ /** Details about cash rounding applied to this payment, when relevant. */
5625
+ cashRounding?: CashRoundingDetails;
5626
+ /**
5627
+ * Overall payment status.
5628
+ *
5629
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5630
+ */
5631
+ status?: PaymentStatusWithLiterals;
5756
5632
  /**
5757
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5758
- * @min 1
5633
+ * Detailed payment status information including gateway reason codes and status-specific details.
5634
+ * @internal
5759
5635
  */
5760
- count?: number;
5761
- /** Duration unit: MINUTES, HOURS and DAYS */
5762
- unit?: DurationUnitWithLiterals;
5763
- }
5764
- declare enum DurationUnit {
5765
- MINUTES = "MINUTES",
5766
- HOURS = "HOURS",
5767
- DAYS = "DAYS"
5768
- }
5769
- /** @enumType */
5770
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5771
- interface PreparePaymentCollectionResponse {
5772
- /** Payment gateway order id which is associated with given payment */
5773
- paymentGatewayOrderId?: string;
5774
- }
5775
- interface GetPaymentCollectabilityStatusRequest {
5636
+ paymentStatusDetails?: PaymentStatusDetails;
5776
5637
  /**
5777
- * Ecom order ID.
5778
- * @minLength 1
5779
- * @maxLength 100
5638
+ * Location where the payment was processed.
5639
+ * @internal
5640
+ * @format GUID
5641
+ * @immutable
5780
5642
  */
5781
- ecomOrderId: string;
5643
+ locationId?: string | null;
5644
+ /**
5645
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5646
+ * @format GUID
5647
+ */
5648
+ chargeCorrelationId?: string | null;
5782
5649
  }
5783
- interface GetPaymentCollectabilityStatusResponse {
5784
- /** Payment collectability status */
5785
- status?: PaymentCollectabilityStatusWithLiterals;
5786
- /** Collectable order amount */
5787
- amount?: Price;
5650
+ /** @oneof */
5651
+ interface PaymentPaymentDetailsOneOf {
5652
+ /** Regular payment details. */
5653
+ regularPaymentDetails?: RegularPaymentDetails;
5654
+ /** Gift card payment details. */
5655
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5656
+ /** Membership payment details. */
5657
+ membershipPaymentDetails?: MembershipPaymentDetails;
5658
+ }
5659
+ /** @oneof */
5660
+ interface PaymentReceiptInfoOneOf {
5788
5661
  /**
5789
- * Whether authorization supported
5662
+ * Receipt created by Wix
5790
5663
  * @internal
5791
5664
  */
5792
- authorizationSupported?: boolean;
5665
+ wixReceipt?: WixReceiptInfo;
5793
5666
  /**
5794
- * Whether custom amount is supported for payment collection
5667
+ * Receipt created by an external system.
5795
5668
  * @internal
5796
5669
  */
5797
- customAmountSupported?: boolean;
5670
+ externalReceipt?: ExternalReceiptInfo;
5798
5671
  }
5799
- declare enum PaymentCollectabilityStatus {
5800
- UNKNOWN = "UNKNOWN",
5801
- COLLECTABLE = "COLLECTABLE",
5802
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5803
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5804
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5805
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5806
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5807
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5808
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5809
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5810
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5811
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5812
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5672
+ /** @oneof */
5673
+ interface PaymentStatusDetailsOneOf {
5674
+ /** @internal */
5675
+ canceled?: CanceledStatusDetails;
5676
+ /** @internal */
5677
+ declined?: DeclinedStatusDetails;
5678
+ /** @internal */
5679
+ voided?: VoidedStatusDetails;
5813
5680
  }
5814
- /** @enumType */
5815
- type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
5816
- interface RecordManuallyCollectedPaymentRequest {
5681
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5682
+ /** Credit card details. */
5683
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5817
5684
  /**
5818
- * Order ID.
5819
- * @minLength 1
5685
+ * Wix Payments order ID.
5820
5686
  * @maxLength 100
5821
5687
  */
5822
- orderId: string;
5823
- /** Amount to be recorded as approved manual payment for given order */
5824
- amount: Price;
5688
+ paymentOrderId?: string | null;
5825
5689
  /**
5826
- * Payment method name provided by user.
5827
- *
5828
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5829
- * @internal
5690
+ * Payment gateway's transaction ID.
5691
+ * This field is only returned when the value of `offline_payment` is `false`.
5692
+ * @maxLength 100
5830
5693
  */
5831
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5832
- }
5833
- /**
5834
- * User-defined payment method name.
5835
- * Allows specifying either a predefined type or a custom name.
5836
- */
5837
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5838
- /** Predefined payment method. */
5839
- predefined?: PredefinedPaymentMethodWithLiterals;
5694
+ gatewayTransactionId?: string | null;
5840
5695
  /**
5841
- * Custom payment method name provided by user.
5842
- *
5843
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5844
- * @minLength 1
5696
+ * Payment method.
5697
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5698
+ * Non-exhaustive list of supported values:
5699
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5845
5700
  * @maxLength 150
5701
+ * @deprecated Payment method.
5702
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5703
+ * Non-exhaustive list of supported values:
5704
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5705
+ * @replacedBy payment_method_name
5706
+ * @targetRemovalDate 2026-07-01
5846
5707
  */
5847
- custom?: string | null;
5848
- }
5849
- /** @oneof */
5850
- interface UserDefinedPaymentMethodNameKindOneOf {
5851
- /** Predefined payment method. */
5852
- predefined?: PredefinedPaymentMethodWithLiterals;
5708
+ paymentMethod?: string | null;
5853
5709
  /**
5854
- * Custom payment method name provided by user.
5855
- *
5856
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5857
- * @minLength 1
5858
- * @maxLength 150
5710
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5711
+ * @maxLength 100
5859
5712
  */
5860
- custom?: string | null;
5861
- }
5862
- /** Predefined payment method types for offline/manual payments. */
5863
- declare enum PredefinedPaymentMethod {
5864
- /** Cash payment. */
5865
- CASH = "CASH",
5866
- /** Bank transfer. */
5867
- BANK_TRANSFER = "BANK_TRANSFER",
5868
- /** Payment by check. */
5869
- CHECK = "CHECK"
5870
- }
5871
- /** @enumType */
5872
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5873
- interface RecordManuallyCollectedPaymentResponse {
5874
- }
5875
- interface MarkOrderAsPaidRequest {
5713
+ providerTransactionId?: string | null;
5714
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5715
+ offlinePayment?: boolean;
5876
5716
  /**
5877
- * Ecom order ID.
5878
- * @minLength 1
5879
- * @maxLength 100
5717
+ * Payment status.
5718
+ * @deprecated Payment status.
5719
+ * @replacedBy payment.status
5720
+ * @targetRemovalDate 2026-11-01
5880
5721
  */
5881
- ecomOrderId: string;
5722
+ status?: TransactionStatusWithLiterals;
5723
+ /** Whether there is a payment agreement that allows for future charges. */
5724
+ savedPaymentMethod?: boolean;
5725
+ /** Authorization details. */
5726
+ authorizationDetails?: AuthorizationDetails;
5882
5727
  /**
5883
- * Payment method name provided by user.
5884
- *
5885
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5728
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5886
5729
  * @internal
5730
+ * @maxLength 300
5887
5731
  */
5888
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5889
- }
5890
- interface MarkOrderAsPaidResponse {
5891
- /** Updated order. */
5892
- order?: Order;
5893
- }
5894
- interface BulkMarkOrdersAsPaidRequest {
5732
+ paymentProvider?: string | null;
5895
5733
  /**
5896
- * IDs of orders to mark as paid.
5897
- * @minSize 1
5898
- * @maxSize 100
5899
- * @minLength 1
5900
- * @maxLength 100
5734
+ * Record of chargebacks made by the buyer.
5735
+ * @maxSize 6
5901
5736
  */
5902
- ecomOrderIds: string[];
5903
- }
5904
- interface BulkMarkOrdersAsPaidResponse {
5737
+ chargebacks?: Chargeback[];
5905
5738
  /**
5906
- * Items updated by the bulk action.
5907
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5739
+ * Payment method ID.
5740
+ * @internal
5741
+ * @maxLength 36
5908
5742
  */
5909
- results?: BulkOrderResult[];
5910
- /** Bulk action metadata. */
5911
- bulkActionMetadata?: BulkActionMetadata;
5912
- }
5913
- interface BulkOrderResult {
5914
- /** Item metadata. */
5915
- itemMetadata?: ItemMetadata;
5743
+ paymentMethodId?: string | null;
5744
+ /** Platform fee amount associated with this payment. */
5745
+ platformFee?: Price;
5916
5746
  /**
5917
- * Updated order.
5918
- *
5919
- * Returned when `returnFullEntity = true`.
5747
+ * Payment method with buyer and optional owner translations.
5748
+ * Non-exhaustive list of supported values:
5749
+ * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5920
5750
  */
5921
- item?: Order;
5922
- }
5923
- interface ItemMetadata {
5924
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5925
- id?: string | null;
5926
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5927
- originalIndex?: number;
5928
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5929
- success?: boolean;
5930
- /** Details about the error in case of failure. */
5931
- error?: ApplicationError;
5751
+ paymentMethodName?: PaymentMethodName;
5932
5752
  }
5933
- interface ApplicationError {
5934
- /** Error code. */
5935
- code?: string;
5936
- /** Description of the error. */
5937
- description?: string;
5938
- /** Data related to the error. */
5939
- data?: Record<string, any> | null;
5753
+ /** @oneof */
5754
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5755
+ /** Credit card details. */
5756
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5940
5757
  }
5941
- interface BulkActionMetadata {
5942
- /** Number of items that were successfully processed. */
5943
- totalSuccesses?: number;
5944
- /** Number of items that couldn't be processed. */
5945
- totalFailures?: number;
5946
- /** Number of failures without details because detailed failure threshold was exceeded. */
5947
- undetailedFailures?: number;
5758
+ declare enum TransactionStatus {
5759
+ UNDEFINED = "UNDEFINED",
5760
+ APPROVED = "APPROVED",
5761
+ PENDING = "PENDING",
5762
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5763
+ CANCELED = "CANCELED",
5764
+ DECLINED = "DECLINED",
5765
+ REFUNDED = "REFUNDED",
5766
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5767
+ AUTHORIZED = "AUTHORIZED",
5768
+ VOIDED = "VOIDED"
5948
5769
  }
5949
- interface GetRefundabilityStatusRequest {
5770
+ /** @enumType */
5771
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5772
+ interface CreditCardPaymentMethodDetails {
5950
5773
  /**
5951
- * Order ID.
5952
- * @minLength 1
5774
+ * The last 4 digits of the card number.
5775
+ * @maxLength 4
5776
+ */
5777
+ lastFourDigits?: string | null;
5778
+ /**
5779
+ * Card issuer's brand.
5953
5780
  * @maxLength 100
5954
5781
  */
5955
- ecomOrderId: string;
5782
+ brand?: string | null;
5956
5783
  }
5957
- interface GetRefundabilityStatusResponse {
5784
+ interface AuthorizationDetails {
5958
5785
  /**
5959
- * Refundability details.
5960
- * @maxSize 300
5786
+ * Whether the authorized payment is of a delayed capture.
5787
+ * @readonly
5961
5788
  */
5962
- refundabilities?: Refundability[];
5789
+ delayedCapture?: boolean;
5790
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5791
+ authorizedDate?: Date | null;
5963
5792
  /**
5964
- * Whether the order supports refunding per item.
5965
- * @deprecated
5793
+ * List of captures associated with payment
5794
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5795
+ * @maxSize 1
5966
5796
  */
5967
- refundablePerItem?: boolean;
5797
+ captures?: AuthorizationCapture[];
5798
+ /** Void associated with payment */
5799
+ void?: AuthorizationVoid;
5800
+ /** Scheduled action for this transaction */
5801
+ scheduledAction?: V1ScheduledAction;
5968
5802
  }
5969
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5970
- /** Reason why payment is not refundable. */
5971
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5972
- /** Reason why payment is only refundable manually. */
5973
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5974
- /** Payment ID. */
5975
- paymentId?: string;
5976
- /** Payment refundability status. */
5977
- refundabilityStatus?: RefundableStatusWithLiterals;
5978
- /** Link to payment provider dashboard. */
5979
- providerLink?: string | null;
5803
+ interface AuthorizationCapture {
5804
+ /**
5805
+ * Capture ID.
5806
+ * @format GUID
5807
+ * @readonly
5808
+ */
5809
+ id?: string | null;
5810
+ /** Status of this capture action */
5811
+ status?: AuthorizationCaptureStatusWithLiterals;
5812
+ /**
5813
+ * Amount of this capture
5814
+ * @immutable
5815
+ */
5816
+ amount?: Price;
5817
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5818
+ createdDate?: Date | null;
5819
+ /** In case of status is FAILED may contain failure details */
5820
+ failureDetails?: AuthorizationActionFailureDetails;
5980
5821
  }
5981
- /** @oneof */
5982
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5983
- /** Reason why payment is not refundable. */
5984
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5985
- /** Reason why payment is only refundable manually. */
5986
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5822
+ declare enum AuthorizationCaptureStatus {
5823
+ /** Capture operation still in progress. */
5824
+ PENDING = "PENDING",
5825
+ /** Capture operation succeeded. */
5826
+ SUCCEEDED = "SUCCEEDED",
5827
+ /** Capture operation failed. */
5828
+ FAILED = "FAILED"
5987
5829
  }
5988
- declare enum RefundableStatus {
5989
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5990
- MANUAL = "MANUAL",
5991
- REFUNDABLE = "REFUNDABLE"
5830
+ /** @enumType */
5831
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5832
+ interface AuthorizationActionFailureDetails {
5833
+ /** @maxLength 100 */
5834
+ failureCode?: string;
5835
+ }
5836
+ interface AuthorizationVoid {
5837
+ /** Status of this void action */
5838
+ status?: AuthorizationVoidStatusWithLiterals;
5839
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5840
+ voidedDate?: Date | null;
5841
+ /** In case of status is FAILED may contain failure details */
5842
+ failureDetails?: AuthorizationActionFailureDetails;
5843
+ /** Reason of void action */
5844
+ reason?: ReasonWithLiterals;
5845
+ }
5846
+ declare enum AuthorizationVoidStatus {
5847
+ /** Void operation still in progress. */
5848
+ PENDING = "PENDING",
5849
+ /** Void operation succeeded. */
5850
+ SUCCEEDED = "SUCCEEDED",
5851
+ /** Void operation failed. */
5852
+ FAILED = "FAILED"
5992
5853
  }
5993
5854
  /** @enumType */
5994
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5995
- declare enum NonRefundableReason {
5996
- NONE = "NONE",
5997
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5998
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5999
- INTERNAL_ERROR = "INTERNAL_ERROR",
6000
- NOT_PAID = "NOT_PAID",
6001
- ACCESS_DENIED = "ACCESS_DENIED",
6002
- ZERO_PRICE = "ZERO_PRICE",
6003
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
6004
- PENDING_REFUND = "PENDING_REFUND",
6005
- FORBIDDEN = "FORBIDDEN",
6006
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
6007
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
6008
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5855
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5856
+ /** Reason the authorization was voided. */
5857
+ declare enum Reason {
5858
+ /** Authorization was voided by user. */
5859
+ MANUAL = "MANUAL",
5860
+ /** Authorization passed execution date. */
5861
+ SCHEDULED = "SCHEDULED"
6009
5862
  }
6010
5863
  /** @enumType */
6011
- type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
6012
- declare enum ManuallyRefundableReason {
6013
- EXPIRED = "EXPIRED",
6014
- NOT_SUPPORTED = "NOT_SUPPORTED",
6015
- OFFLINE = "OFFLINE",
6016
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5864
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5865
+ interface V1ScheduledAction {
5866
+ /** Type of the action. */
5867
+ actionType?: ActionTypeWithLiterals;
5868
+ /** The date and time of the action. */
5869
+ executionDate?: Date | null;
5870
+ }
5871
+ declare enum ActionType {
5872
+ VOID = "VOID",
5873
+ CAPTURE = "CAPTURE"
6017
5874
  }
6018
5875
  /** @enumType */
6019
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
6020
- interface CreatePaymentGatewayOrderRequest {
5876
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5877
+ interface Chargeback {
6021
5878
  /**
6022
- * Ecom order ID.
6023
- * @minLength 1
6024
- * @maxLength 100
5879
+ * Chargeback ID.
5880
+ * @format GUID
5881
+ * @readonly
5882
+ * @immutable
6025
5883
  */
6026
- ecomOrderId: string;
6027
- /** Information about the user who initiated the payment. */
6028
- chargedBy?: ChargedBy;
5884
+ id?: string;
6029
5885
  /**
6030
- * Whether to delay capture of the payment.
5886
+ * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5887
+ * @readonly
5888
+ * @immutable
5889
+ */
5890
+ createdDate?: Date | null;
5891
+ /**
5892
+ * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
5893
+ * @readonly
5894
+ */
5895
+ updatedDate?: Date | null;
5896
+ /**
5897
+ * Amount.
5898
+ * @readonly
5899
+ * @immutable
5900
+ */
5901
+ amount?: Price;
5902
+ /**
5903
+ * Reversal amount. Present only when status is REVERSED.
5904
+ * @readonly
5905
+ */
5906
+ reversalAmount?: Price;
5907
+ /**
5908
+ * Status.
6031
5909
  *
6032
- * Default: false
6033
- * @internal
5910
+ * Default: `"APPROVED"`.
6034
5911
  */
6035
- delayedCapture?: boolean;
6036
- }
6037
- interface ChargedBy {
5912
+ status?: ChargebackStatusWithLiterals;
6038
5913
  /**
6039
- * ID - id of the user who initiated the payment
5914
+ * External chargeback ID.
6040
5915
  * @format GUID
5916
+ * @readonly
5917
+ * @immutable
6041
5918
  */
6042
- id?: string;
5919
+ externalId?: string | null;
5920
+ }
5921
+ declare enum ChargebackStatus {
5922
+ /** Chargeback was approved. */
5923
+ APPROVED = "APPROVED",
5924
+ /** Chargeback was reversed. */
5925
+ REVERSED = "REVERSED"
5926
+ }
5927
+ /** @enumType */
5928
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5929
+ interface PaymentMethodName {
6043
5930
  /**
6044
- * Full name - name of the user who initiated the payment
6045
- * @minLength 1
6046
- * @maxLength 200
5931
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5932
+ * @maxLength 150
6047
5933
  */
6048
- fullName?: string | null;
6049
- }
6050
- interface CreatePaymentGatewayOrderResponse {
6051
- /** ID of the order created in the payment gateway */
6052
- paymentGatewayOrderId?: string;
5934
+ buyerLanguageName?: string | null;
5935
+ /**
5936
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5937
+ *
5938
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5939
+ * @maxLength 150
5940
+ */
5941
+ siteLanguageName?: string | null;
5942
+ /**
5943
+ * User-provided payment method name.
5944
+ *
5945
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5946
+ */
5947
+ userDefinedName?: UserDefinedPaymentMethodName;
6053
5948
  }
6054
- interface ChargeMembershipsRequest {
5949
+ interface GiftCardPaymentDetails {
6055
5950
  /**
6056
- * Order ID.
6057
- * @minLength 1
5951
+ * Gift card payment ID.
6058
5952
  * @maxLength 100
6059
5953
  */
6060
- ecomOrderId: string;
5954
+ giftCardPaymentId?: string;
6061
5955
  /**
6062
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
6063
- * but a user which is using the membership on behalf of the a member
5956
+ * Gift card ID.
5957
+ * @internal
5958
+ * @deprecated
5959
+ */
5960
+ giftCardId?: string;
5961
+ /**
5962
+ * ID of the app that created the gift card.
6064
5963
  * @format GUID
6065
5964
  */
6066
- memberId: string;
5965
+ appId?: string;
5966
+ /**
5967
+ * Whether the gift card is voided.
5968
+ * @readonly
5969
+ * @deprecated Whether the gift card is voided.
5970
+ * @replacedBy payment.status
5971
+ * @targetRemovalDate 2026-11-01
5972
+ */
5973
+ voided?: boolean;
6067
5974
  /**
6068
- * List of items to be paid by memberships
6069
- * @minSize 1
6070
- * @maxSize 300
5975
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5976
+ * @maxLength 30
5977
+ * @immutable
6071
5978
  */
6072
- membershipCharges?: MembershipChargeItem[];
5979
+ obfuscatedCode?: string | null;
6073
5980
  }
6074
- interface MembershipChargeItem {
5981
+ interface MembershipPaymentDetails {
6075
5982
  /**
6076
- * The id of used membership
6077
- * @minLength 1
6078
- * @maxLength 100
5983
+ * Membership ID.
5984
+ * @maxLength 200
6079
5985
  */
6080
5986
  membershipId?: string;
6081
5987
  /**
6082
- * ID of the application providing this payment option
6083
- * @format GUID
5988
+ * ID of the line item this membership applies to.
5989
+ * @minLength 1
5990
+ * @maxLength 100
6084
5991
  */
6085
- appId?: string;
6086
- /** The name of used membership */
6087
- membershipName?: MembershipName;
6088
- /** Additional data about this membership */
6089
- membershipAdditionalData?: Record<string, any> | null;
6090
- /** Catalog and item reference info. */
6091
- catalogReference?: CatalogReference;
6092
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
6093
- serviceProperties?: ServiceProperties;
5992
+ lineItemId?: string;
6094
5993
  /**
6095
- * Usually would be the same as catalogReference.catalogItemId
6096
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
6097
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
6098
- * @minLength 1
6099
- * @maxLength 36
5994
+ * Payment status.
5995
+ * @deprecated Payment status.
5996
+ * @replacedBy payment.status
5997
+ * @targetRemovalDate 2026-11-01
6100
5998
  */
6101
- rootCatalogItemId?: string | null;
5999
+ status?: MembershipPaymentStatusWithLiterals;
6000
+ /** Membership name. */
6001
+ name?: MembershipName;
6102
6002
  /**
6103
- * line item id of Checkout/Order line item
6003
+ * The transaction ID in the membership system. Can be used to void the transaction.
6104
6004
  * @minLength 1
6105
6005
  * @maxLength 100
6106
6006
  */
6107
- lineItemId?: string;
6108
- }
6109
- interface MembershipName {
6007
+ externalTransactionId?: string | null;
6110
6008
  /**
6111
- * Membership name in the site's original language.
6112
- * @maxLength 100
6009
+ * Whether the membership is voided.
6010
+ * @readonly
6011
+ * @deprecated Whether the membership is voided.
6012
+ * @replacedBy payment.status
6013
+ * @targetRemovalDate 2026-11-01
6113
6014
  */
6114
- original?: string;
6015
+ voided?: boolean;
6115
6016
  /**
6116
- * Membership name translated into the buyer's language.
6117
- *
6118
- * Default: The value of `original`
6119
- * @maxLength 100
6017
+ * ID of the application providing this payment option.
6018
+ * @format GUID
6120
6019
  */
6121
- translated?: string | null;
6020
+ providerAppId?: string;
6021
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6022
+ futureMembership?: FutureMembershipDetails;
6122
6023
  }
6123
- interface ChargeMembershipsResponse {
6024
+ declare enum MembershipPaymentStatus {
6025
+ /** Payment was charged. */
6026
+ CHARGED = "CHARGED",
6027
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6028
+ CHARGE_FAILED = "CHARGE_FAILED",
6029
+ /** Payment is pending. */
6030
+ CHARGE_PENDING = "CHARGE_PENDING",
6031
+ /** Payment was voided. */
6032
+ VOIDED = "VOIDED"
6124
6033
  }
6125
- interface TriggerRefundRequest {
6034
+ /** @enumType */
6035
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6036
+ interface FutureMembershipDetails {
6126
6037
  /**
6127
- * The order this refund related to
6128
- * @minLength 1
6129
- * @maxLength 100
6038
+ * ID of the plan line item in the order from which the membership will be created.
6039
+ * @format GUID
6130
6040
  */
6131
- ecomOrderId: string;
6041
+ lineItemId?: string;
6132
6042
  /**
6133
- * Refund operations information
6134
- * @minSize 1
6135
- * @maxSize 1
6043
+ * ID of the benefit the future membership will grant.
6044
+ * @maxLength 200
6136
6045
  */
6137
- payments: PaymentRefund[];
6138
- /** Business model of a refund */
6139
- details?: RefundDetails;
6140
- /** Side effect details related to refund */
6141
- sideEffects?: RefundSideEffects;
6046
+ benefitId?: string;
6142
6047
  }
6143
- interface PaymentRefund {
6048
+ interface WixReceiptInfo {
6144
6049
  /**
6145
- * Specific payment within the order to refund
6050
+ * Receipt ID
6146
6051
  * @format GUID
6147
6052
  */
6148
- paymentId?: string;
6149
- /** Refund amount. Not relevant for membership and gift card refunds. */
6150
- amount?: Price;
6151
- /**
6152
- * Whether refund is made externally and manually (on the payment provider's side)
6153
- * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
6154
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
6155
- */
6156
- externalRefund?: boolean;
6053
+ receiptId?: string;
6157
6054
  /**
6158
- * Gateway refund id. When param is present, new refund is not created.
6159
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6160
- * and all side effects from request will be executed.
6161
- * @internal
6055
+ * Display number of receipt
6162
6056
  * @minLength 1
6163
- * @maxLength 100
6057
+ * @maxLength 40
6164
6058
  */
6165
- gatewayRefundId?: string | null;
6059
+ displayNumber?: string | null;
6166
6060
  }
6167
- interface RefundSideEffects {
6168
- /** Inventory restock details as part of this refund. */
6169
- restockInfo?: RestockInfo;
6170
- /** Whether to send a refund confirmation email to the customer. */
6171
- sendOrderRefundedEmail?: boolean;
6061
+ interface ExternalReceiptInfo {
6172
6062
  /**
6173
- * Custom message added to the refund confirmation email.
6174
- * @minLength 1
6175
- * @maxLength 1000
6063
+ * External receipt ID
6064
+ * @maxLength 100
6176
6065
  */
6177
- customMessage?: string | null;
6178
- }
6179
- interface RestockInfo {
6180
- /** Restock type. */
6181
- type?: RestockTypeWithLiterals;
6066
+ receiptId?: string | null;
6182
6067
  /**
6183
- * Deprecated, use items instead
6184
- * @internal
6185
- * @maxSize 300
6186
- * @deprecated
6068
+ * ID of the app providing the receipt
6069
+ * @format GUID
6187
6070
  */
6188
- lineItemIds?: string[];
6071
+ appId?: string | null;
6189
6072
  /**
6190
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6191
- * @maxSize 300
6073
+ * Display number of receipt
6074
+ * @minLength 1
6075
+ * @maxLength 40
6192
6076
  */
6193
- items?: RestockItem[];
6194
- }
6195
- declare enum RestockType {
6196
- NO_ITEMS = "NO_ITEMS",
6197
- ALL_ITEMS = "ALL_ITEMS",
6198
- SOME_ITEMS = "SOME_ITEMS"
6077
+ displayNumber?: string | null;
6199
6078
  }
6200
- /** @enumType */
6201
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6202
- interface RestockItem {
6079
+ interface CashRoundingDetails {
6203
6080
  /**
6204
- * ID of the line item being restocked.
6205
- * @format GUID
6081
+ * Payment amount before cash rounding was applied.
6082
+ * When provided, balance and status calculations use this value instead of `amount`
6083
+ * to prevent false overpayment or underpayment due to rounding.
6206
6084
  */
6207
- lineItemId?: string;
6085
+ unroundedAmount?: Price;
6208
6086
  /**
6209
- * Line item quantity being restocked.
6210
- * @min 1
6211
- * @max 100000
6087
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6088
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6089
+ * @readonly
6212
6090
  */
6213
- quantity?: number;
6091
+ roundingAdjustment?: CashRounding;
6092
+ }
6093
+ declare enum PaymentStatus {
6094
+ /** Payment was charged successfully. */
6095
+ APPROVED = "APPROVED",
6096
+ /** Payment is being processed and hasn't been confirmed yet. */
6097
+ PENDING = "PENDING",
6098
+ /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
6099
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6100
+ /** Payment was canceled before it was charged. */
6101
+ CANCELED = "CANCELED",
6102
+ /** Payment was declined by the payment provider. */
6103
+ DECLINED = "DECLINED",
6104
+ /** Payment was fully refunded. */
6105
+ REFUNDED = "REFUNDED",
6106
+ /** Part of the payment amount was refunded. */
6107
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6108
+ /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
6109
+ AUTHORIZED = "AUTHORIZED",
6214
6110
  /**
6215
- * Per-location breakdown of restock quantities.
6216
- * @internal
6217
- * @maxSize 5
6111
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6112
+ *
6113
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6218
6114
  */
6219
- restockLocations?: RestockLocation[];
6115
+ VOIDED = "VOIDED"
6220
6116
  }
6221
- interface TriggerRefundResponse {
6222
- /** All order's transactions after the refunds were added */
6223
- orderTransactions?: OrderTransactions;
6224
- /** Created refund ID */
6225
- refundId?: string | null;
6226
- /** Payment ID's that the refund execution had failed for */
6227
- failedPaymentIds?: ItemMetadata[];
6117
+ /** @enumType */
6118
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6119
+ interface CanceledStatusDetails {
6120
+ reason?: CanceledReasonWithLiterals;
6228
6121
  }
6229
- /**
6230
- * A record of all payments and refunds associated with an order.
6231
- *
6232
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6233
- */
6234
- interface OrderTransactions {
6235
- /**
6236
- * Order ID.
6237
- * @format GUID
6238
- */
6239
- orderId?: string;
6240
- /**
6241
- * Record of payments made to the merchant.
6242
- * @maxSize 100
6243
- */
6244
- payments?: Payment[];
6245
- /**
6246
- * Record of refunds made to the buyer.
6247
- * @maxSize 300
6248
- */
6249
- refunds?: Refund[];
6122
+ declare enum CanceledReason {
6123
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6124
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6125
+ /** Payment was not completed by user and expired. */
6126
+ EXPIRED = "EXPIRED"
6127
+ }
6128
+ /** @enumType */
6129
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6130
+ interface DeclinedStatusDetails {
6131
+ reason?: DeclinedReasonWithLiterals;
6132
+ }
6133
+ declare enum DeclinedReason {
6134
+ /** Corresponding charge failed. */
6135
+ CHARGE_FAILED = "CHARGE_FAILED",
6136
+ /** Payment details expired. */
6137
+ EXPIRED = "EXPIRED",
6138
+ /** Insufficient funds. */
6139
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6140
+ /** Gift card was disabled before charge was attempted. */
6141
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6250
6142
  }
6251
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6252
- /** Regular payment details. */
6253
- regularPaymentDetails?: RegularPaymentDetails;
6254
- /** Gift card payment details. */
6255
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6256
- /** Membership payment details. */
6257
- membershipPaymentDetails?: MembershipPaymentDetails;
6258
- /**
6259
- * Receipt created by Wix
6260
- * @internal
6261
- */
6262
- wixReceipt?: WixReceiptInfo;
6143
+ /** @enumType */
6144
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6145
+ interface VoidedStatusDetails {
6146
+ reason?: VoidedReasonWithLiterals;
6147
+ }
6148
+ declare enum VoidedReason {
6149
+ /** Payment was voided by merchant request. */
6150
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6151
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6152
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6153
+ }
6154
+ /** @enumType */
6155
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6156
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6157
+ /** @internal */
6158
+ canceled?: CanceledStatusDetails;
6159
+ /** @internal */
6160
+ declined?: DeclinedStatusDetails;
6161
+ /** @internal */
6162
+ voided?: VoidedStatusDetails;
6263
6163
  /**
6264
- * Receipt created by an external system.
6164
+ * Reason code from the payment gateway.
6265
6165
  * @internal
6166
+ * @minLength 1
6167
+ * @maxLength 10
6266
6168
  */
6267
- externalReceipt?: ExternalReceiptInfo;
6169
+ paymentGatewayReasonCode?: string | null;
6170
+ }
6171
+ /** @oneof */
6172
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6268
6173
  /** @internal */
6269
6174
  canceled?: CanceledStatusDetails;
6270
6175
  /** @internal */
6271
6176
  declined?: DeclinedStatusDetails;
6272
6177
  /** @internal */
6273
6178
  voided?: VoidedStatusDetails;
6179
+ }
6180
+ interface Refund {
6274
6181
  /**
6275
- * Payment ID.
6182
+ * Refund ID.
6276
6183
  * @format GUID
6277
6184
  * @readonly
6278
6185
  */
6279
- id?: string | null;
6280
- /** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
6281
- createdDate?: Date | null;
6186
+ id?: string;
6282
6187
  /**
6283
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6188
+ * List of transactions.
6189
+ * @maxSize 50
6190
+ */
6191
+ transactions?: RefundTransaction[];
6192
+ /** Refund business details. */
6193
+ details?: RefundDetails;
6194
+ /**
6195
+ * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6284
6196
  * @readonly
6197
+ * @immutable
6285
6198
  */
6286
- updatedDate?: Date | null;
6287
- /** Payment amount. */
6288
- amount?: Price;
6199
+ createdDate?: Date | null;
6289
6200
  /**
6290
- * Whether refunds for this payment are disabled.
6291
- * + `true`: This payment is not refundable.
6292
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6201
+ * Aggregated refund summary.
6202
+ * @readonly
6293
6203
  */
6294
- refundDisabled?: boolean;
6204
+ summary?: AggregatedRefundSummary;
6295
6205
  /**
6296
- * Whether receipt generation is allowed for this payment.
6297
- * + `true`: This payment supports receipt generation.
6298
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6206
+ * ID of the app that initiated this refund.
6207
+ * @format GUID
6299
6208
  * @readonly
6209
+ * @immutable
6300
6210
  */
6301
- supportReceiptGeneration?: boolean;
6302
- /** Details about cash rounding applied to this payment, when relevant. */
6303
- cashRounding?: CashRoundingDetails;
6211
+ requestingServiceAppId?: string | null;
6212
+ }
6213
+ interface RefundTransaction {
6304
6214
  /**
6305
- * Overall payment status.
6306
- *
6307
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6215
+ * ID of the payment associated with this refund.
6216
+ * @format GUID
6217
+ * @immutable
6308
6218
  */
6309
- status?: PaymentStatusWithLiterals;
6219
+ paymentId?: string;
6310
6220
  /**
6311
- * Detailed payment status information including gateway reason codes and status-specific details.
6312
- * @internal
6221
+ * Refund amount.
6222
+ * @immutable
6313
6223
  */
6314
- paymentStatusDetails?: PaymentStatusDetails;
6224
+ amount?: Price;
6225
+ /** Refund status. */
6226
+ refundStatus?: RefundStatusWithLiterals;
6227
+ /** Optional details of current refund status. */
6228
+ refundStatusInfo?: RefundStatusInfo;
6315
6229
  /**
6316
- * Location where the payment was processed.
6230
+ * Payment gateway's refund ID.
6231
+ * This field is only returned when the value of `external_refund` is `false`.
6232
+ * @format GUID
6233
+ */
6234
+ gatewayRefundId?: string | null;
6235
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6236
+ providerRefundId?: string | null;
6237
+ /**
6238
+ * Whether refund was made externally and manually on the payment provider's side.
6239
+ * @immutable
6240
+ */
6241
+ externalRefund?: boolean;
6242
+ /**
6243
+ * Location where the refund was processed.
6317
6244
  * @internal
6318
6245
  * @format GUID
6319
6246
  * @immutable
6320
6247
  */
6321
6248
  locationId?: string | null;
6249
+ }
6250
+ /** Refund transaction status. */
6251
+ declare enum RefundStatus {
6252
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6253
+ PENDING = "PENDING",
6254
+ /** Refund transaction succeeded. */
6255
+ SUCCEEDED = "SUCCEEDED",
6256
+ /** Refund transaction failed. */
6257
+ FAILED = "FAILED",
6258
+ /** Refund request acknowledged, and will be executed soon. */
6259
+ SCHEDULED = "SCHEDULED",
6260
+ /** Refund was initiated on payment provider side. */
6261
+ STARTED = "STARTED"
6262
+ }
6263
+ /** @enumType */
6264
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6265
+ interface RefundStatusInfo {
6322
6266
  /**
6323
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6267
+ * Reason code for the refund's current status.
6268
+ *
6269
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6270
+ * @minLength 1
6271
+ * @maxLength 10
6272
+ */
6273
+ paymentGatewayReasonCode?: string | null;
6274
+ /**
6275
+ * Free text explanation of current refund status.
6276
+ * @minLength 1
6277
+ * @maxLength 1000
6278
+ */
6279
+ description?: string | null;
6280
+ }
6281
+ interface AggregatedRefundSummary {
6282
+ /** Total amount requested for refund. */
6283
+ requestedRefund?: Price;
6284
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6285
+ pendingRefund?: Price;
6286
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6287
+ refunded?: Price;
6288
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6289
+ failedRefundAmount?: Price;
6290
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6291
+ pending?: boolean;
6292
+ /** Breakdown of refunded items. Available only after refund is complete. */
6293
+ breakdown?: RefundItemsBreakdown;
6294
+ }
6295
+ interface RefundItemsBreakdown {
6296
+ /**
6297
+ * Refunded line items and the amount refunded for each.
6298
+ * @maxSize 300
6299
+ */
6300
+ lineItems?: LineItemRefundSummary[];
6301
+ }
6302
+ interface LineItemRefundSummary {
6303
+ /**
6304
+ * ID of the refunded line item.
6324
6305
  * @format GUID
6325
6306
  */
6326
- chargeCorrelationId?: string | null;
6307
+ lineItemId?: string;
6308
+ /** Total refunded amount for the line item. */
6309
+ totalRefundedAmount?: Price;
6327
6310
  }
6328
- /** @oneof */
6329
- interface PaymentPaymentDetailsOneOf {
6330
- /** Regular payment details. */
6331
- regularPaymentDetails?: RegularPaymentDetails;
6332
- /** Gift card payment details. */
6333
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6334
- /** Membership payment details. */
6335
- membershipPaymentDetails?: MembershipPaymentDetails;
6311
+ interface CalculateRefundRequest {
6312
+ /**
6313
+ * Order ID
6314
+ * @minLength 1
6315
+ * @maxLength 100
6316
+ */
6317
+ ecomOrderId?: string;
6318
+ /**
6319
+ * Refunded line items and quantity
6320
+ * @maxSize 300
6321
+ */
6322
+ refundItems?: CalculateRefundItemRequest[];
6323
+ /** Should include shipping in refund calculation */
6324
+ refundShipping?: boolean;
6336
6325
  }
6337
- /** @oneof */
6338
- interface PaymentReceiptInfoOneOf {
6326
+ interface CalculateRefundItemRequest {
6339
6327
  /**
6340
- * Receipt created by Wix
6341
- * @internal
6328
+ * ID of the line item being refunded
6329
+ * @format GUID
6342
6330
  */
6343
- wixReceipt?: WixReceiptInfo;
6331
+ id?: string;
6344
6332
  /**
6345
- * Receipt created by an external system.
6346
- * @internal
6333
+ * How much of that line item is being refunded
6334
+ * @min 1
6335
+ * @max 100000
6347
6336
  */
6348
- externalReceipt?: ExternalReceiptInfo;
6337
+ quantity?: number;
6349
6338
  }
6350
- /** @oneof */
6351
- interface PaymentStatusDetailsOneOf {
6352
- /** @internal */
6353
- canceled?: CanceledStatusDetails;
6354
- /** @internal */
6355
- declined?: DeclinedStatusDetails;
6356
- /** @internal */
6357
- voided?: VoidedStatusDetails;
6339
+ interface CalculateRefundResponse {
6340
+ /** Total refundable amount */
6341
+ total?: Price;
6342
+ /** Tax cost of the order */
6343
+ tax?: Price;
6344
+ /** Discount given for this order */
6345
+ discount?: Price;
6346
+ /** Total cost of the order (without tax) */
6347
+ subtotal?: Price;
6348
+ /** Total shipping cost for order */
6349
+ shipping?: Price;
6350
+ /** Previous refund given on that order */
6351
+ previouslyRefundedAmount?: Price;
6352
+ /**
6353
+ * The refundable items of that order
6354
+ * @maxSize 300
6355
+ */
6356
+ items?: CalculateRefundItemResponse[];
6358
6357
  }
6359
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6360
- /** Credit card details. */
6361
- creditCardDetails?: CreditCardPaymentMethodDetails;
6358
+ interface CalculateRefundItemResponse {
6362
6359
  /**
6363
- * Wix Payments order ID.
6364
- * @maxLength 100
6360
+ * Line item ID
6361
+ * @format GUID
6365
6362
  */
6366
- paymentOrderId?: string | null;
6363
+ id?: string;
6364
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6365
+ price?: Price;
6366
+ }
6367
+ interface VoidAuthorizedPaymentsRequest {
6367
6368
  /**
6368
- * Payment gateway's transaction ID.
6369
- * This field is only returned when the value of `offline_payment` is `false`.
6369
+ * Wix eCommerce order ID
6370
+ * @minLength 1
6370
6371
  * @maxLength 100
6371
6372
  */
6372
- gatewayTransactionId?: string | null;
6373
+ ecomOrderId: string;
6373
6374
  /**
6374
- * Payment method.
6375
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6376
- * Non-exhaustive list of supported values:
6377
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6378
- * @maxLength 150
6379
- * @deprecated Payment method.
6380
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6381
- * Non-exhaustive list of supported values:
6382
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6383
- * @replacedBy payment_method_name
6384
- * @targetRemovalDate 2026-07-01
6375
+ * Payment IDs
6376
+ * @minSize 1
6377
+ * @maxSize 100
6378
+ * @format GUID
6385
6379
  */
6386
- paymentMethod?: string | null;
6380
+ paymentIds: string[];
6381
+ }
6382
+ interface VoidAuthorizedPaymentsResponse {
6383
+ /** All order's transactions after the void was triggered */
6384
+ orderTransactions?: OrderTransactions;
6385
+ }
6386
+ interface CaptureAuthorizedPaymentsRequest {
6387
6387
  /**
6388
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6388
+ * Wix eCommerce order ID
6389
+ * @minLength 1
6389
6390
  * @maxLength 100
6390
6391
  */
6391
- providerTransactionId?: string | null;
6392
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6393
- offlinePayment?: boolean;
6394
- /**
6395
- * Payment status.
6396
- * @deprecated Payment status.
6397
- * @replacedBy payment.status
6398
- * @targetRemovalDate 2026-11-01
6399
- */
6400
- status?: TransactionStatusWithLiterals;
6401
- /** Whether there is a payment agreement that allows for future charges. */
6402
- savedPaymentMethod?: boolean;
6403
- /** Authorization details. */
6404
- authorizationDetails?: AuthorizationDetails;
6392
+ ecomOrderId: string;
6405
6393
  /**
6406
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6407
- * @internal
6408
- * @maxLength 300
6394
+ * Capture payments information
6395
+ * @minSize 1
6396
+ * @maxSize 100
6409
6397
  */
6410
- paymentProvider?: string | null;
6398
+ payments: PaymentCapture[];
6399
+ }
6400
+ interface PaymentCapture {
6411
6401
  /**
6412
- * Record of chargebacks made by the buyer.
6413
- * @maxSize 6
6402
+ * Payment ID
6403
+ * @format GUID
6414
6404
  */
6415
- chargebacks?: Chargeback[];
6405
+ paymentId?: string | null;
6416
6406
  /**
6417
- * Payment method ID.
6418
- * @internal
6419
- * @maxLength 36
6407
+ * Capture amount.
6408
+ * If not provided - full authorized amount will be captured.
6420
6409
  */
6421
- paymentMethodId?: string | null;
6422
- /** Platform fee amount associated with this payment. */
6423
- platformFee?: Price;
6410
+ amount?: Price;
6411
+ }
6412
+ interface CaptureAuthorizedPaymentsResponse {
6413
+ /** All order's transactions after the capture was triggered */
6414
+ orderTransactions?: OrderTransactions;
6415
+ }
6416
+ interface ChargeSavedPaymentMethodRequest {
6424
6417
  /**
6425
- * Payment method with buyer and optional owner translations.
6426
- * Non-exhaustive list of supported values:
6427
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
6418
+ * Ecom Order ID.
6419
+ * @minLength 1
6420
+ * @maxLength 100
6428
6421
  */
6429
- paymentMethodName?: PaymentMethodName;
6422
+ ecomOrderId?: string;
6423
+ /** Amount to be charged */
6424
+ amount?: Price;
6430
6425
  }
6431
- /** @oneof */
6432
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6433
- /** Credit card details. */
6434
- creditCardDetails?: CreditCardPaymentMethodDetails;
6426
+ interface ChargeSavedPaymentMethodResponse {
6427
+ /** Payment gateway's order ID (e.g Wix Payments) */
6428
+ paymentGatewayOrderId?: string;
6435
6429
  }
6436
- declare enum TransactionStatus {
6437
- UNDEFINED = "UNDEFINED",
6438
- APPROVED = "APPROVED",
6439
- PENDING = "PENDING",
6440
- PENDING_MERCHANT = "PENDING_MERCHANT",
6441
- CANCELED = "CANCELED",
6442
- DECLINED = "DECLINED",
6443
- REFUNDED = "REFUNDED",
6444
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6445
- AUTHORIZED = "AUTHORIZED",
6446
- VOIDED = "VOIDED"
6430
+ interface SendBuyerConfirmationEmailRequest {
6431
+ /** @format GUID */
6432
+ orderId?: string;
6447
6433
  }
6448
- /** @enumType */
6449
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6450
- interface CreditCardPaymentMethodDetails {
6451
- /**
6452
- * The last 4 digits of the card number.
6453
- * @maxLength 4
6454
- */
6455
- lastFourDigits?: string | null;
6434
+ interface SendBuyerConfirmationEmailResponse {
6435
+ }
6436
+ interface SendBuyerPaymentsReceivedEmailRequest {
6456
6437
  /**
6457
- * Card issuer's brand.
6438
+ * @minLength 1
6458
6439
  * @maxLength 100
6459
6440
  */
6460
- brand?: string | null;
6441
+ orderId?: string;
6461
6442
  }
6462
- interface AuthorizationDetails {
6463
- /**
6464
- * Whether the authorized payment is of a delayed capture.
6465
- * @readonly
6466
- */
6467
- delayedCapture?: boolean;
6468
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6469
- authorizedDate?: Date | null;
6470
- /**
6471
- * List of captures associated with payment
6472
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6473
- * @maxSize 1
6474
- */
6475
- captures?: AuthorizationCapture[];
6476
- /** Void associated with payment */
6477
- void?: AuthorizationVoid;
6478
- /** Scheduled action for this transaction */
6479
- scheduledAction?: V1ScheduledAction;
6443
+ interface SendBuyerPaymentsReceivedEmailResponse {
6480
6444
  }
6481
- interface AuthorizationCapture {
6445
+ interface SendBuyerPickupConfirmationEmailRequest {
6482
6446
  /**
6483
- * Capture ID.
6484
- * @format GUID
6485
- * @readonly
6447
+ * @minLength 1
6448
+ * @maxLength 100
6486
6449
  */
6487
- id?: string | null;
6488
- /** Status of this capture action */
6489
- status?: AuthorizationCaptureStatusWithLiterals;
6450
+ orderId?: string;
6451
+ }
6452
+ interface SendBuyerPickupConfirmationEmailResponse {
6453
+ }
6454
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
6490
6455
  /**
6491
- * Amount of this capture
6492
- * @immutable
6456
+ * IDs of orders to send pickup emails for.
6457
+ * @minSize 1
6458
+ * @maxSize 300
6493
6459
  */
6494
- amount?: Price;
6495
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6496
- createdDate?: Date | null;
6497
- /** In case of status is FAILED may contain failure details */
6498
- failureDetails?: AuthorizationActionFailureDetails;
6460
+ orderIds?: string[];
6499
6461
  }
6500
- declare enum AuthorizationCaptureStatus {
6501
- /** Capture operation still in progress. */
6502
- PENDING = "PENDING",
6503
- /** Capture operation succeeded. */
6504
- SUCCEEDED = "SUCCEEDED",
6505
- /** Capture operation failed. */
6506
- FAILED = "FAILED"
6462
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
6507
6463
  }
6508
- /** @enumType */
6509
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6510
- interface AuthorizationActionFailureDetails {
6511
- /** @maxLength 100 */
6512
- failureCode?: string;
6464
+ interface SendBuyerShippingConfirmationEmailRequest {
6465
+ /**
6466
+ * @minLength 1
6467
+ * @maxLength 100
6468
+ */
6469
+ orderId?: string;
6513
6470
  }
6514
- interface AuthorizationVoid {
6515
- /** Status of this void action */
6516
- status?: AuthorizationVoidStatusWithLiterals;
6517
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6518
- voidedDate?: Date | null;
6519
- /** In case of status is FAILED may contain failure details */
6520
- failureDetails?: AuthorizationActionFailureDetails;
6521
- /** Reason of void action */
6522
- reason?: ReasonWithLiterals;
6471
+ interface SendBuyerShippingConfirmationEmailResponse {
6523
6472
  }
6524
- declare enum AuthorizationVoidStatus {
6525
- /** Void operation still in progress. */
6526
- PENDING = "PENDING",
6527
- /** Void operation succeeded. */
6528
- SUCCEEDED = "SUCCEEDED",
6529
- /** Void operation failed. */
6530
- FAILED = "FAILED"
6473
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
6474
+ /**
6475
+ * IDs of orders to send pickup emails for.
6476
+ * @minSize 1
6477
+ * @maxSize 300
6478
+ */
6479
+ orderIds?: string[];
6531
6480
  }
6532
- /** @enumType */
6533
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6534
- /** Reason the authorization was voided. */
6535
- declare enum Reason {
6536
- /** Authorization was voided by user. */
6537
- MANUAL = "MANUAL",
6538
- /** Authorization passed execution date. */
6539
- SCHEDULED = "SCHEDULED"
6481
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
6540
6482
  }
6541
- /** @enumType */
6542
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6543
- interface V1ScheduledAction {
6544
- /** Type of the action. */
6545
- actionType?: ActionTypeWithLiterals;
6546
- /** The date and time of the action. */
6547
- executionDate?: Date | null;
6483
+ interface SendMerchantOrderReceivedNotificationRequest {
6484
+ /**
6485
+ * @minLength 1
6486
+ * @maxLength 100
6487
+ */
6488
+ orderId?: string;
6548
6489
  }
6549
- declare enum ActionType {
6550
- VOID = "VOID",
6551
- CAPTURE = "CAPTURE"
6490
+ interface SendMerchantOrderReceivedNotificationResponse {
6552
6491
  }
6553
- /** @enumType */
6554
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6555
- interface Chargeback {
6492
+ interface SendCancelRefundEmailRequest {
6556
6493
  /**
6557
- * Chargeback ID.
6558
- * @format GUID
6559
- * @readonly
6560
- * @immutable
6494
+ * The ID of order that is canceled/refunded
6495
+ * @minLength 1
6496
+ * @maxLength 100
6561
6497
  */
6562
- id?: string;
6498
+ orderId?: string;
6563
6499
  /**
6564
- * Date and time the chargeback was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6565
- * @readonly
6566
- * @immutable
6500
+ * Personal note added to the email (optional)
6501
+ * @minLength 1
6502
+ * @maxLength 1000
6567
6503
  */
6568
- createdDate?: Date | null;
6504
+ customMessage?: string | null;
6505
+ /** Refund amount */
6506
+ refundAmount?: Price;
6569
6507
  /**
6570
- * Date and time the chargeback was updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6571
- * @readonly
6508
+ * Refund ID. (Optional)
6509
+ * @format GUID
6572
6510
  */
6573
- updatedDate?: Date | null;
6511
+ refundId?: string | null;
6512
+ }
6513
+ interface SendCancelRefundEmailResponse {
6514
+ }
6515
+ interface SendRefundEmailRequest {
6574
6516
  /**
6575
- * Amount.
6576
- * @readonly
6577
- * @immutable
6517
+ * The ID of order that is refunded
6518
+ * @format GUID
6578
6519
  */
6579
- amount?: Price;
6520
+ orderId?: string;
6580
6521
  /**
6581
- * Reversal amount. Present only when status is REVERSED.
6582
- * @readonly
6522
+ * Refund ID
6523
+ * @format GUID
6583
6524
  */
6584
- reversalAmount?: Price;
6525
+ refundId?: string;
6585
6526
  /**
6586
- * Status.
6587
- *
6588
- * Default: `"APPROVED"`.
6527
+ * Personal note added to the email (optional)
6528
+ * @minLength 1
6529
+ * @maxLength 1000
6589
6530
  */
6590
- status?: ChargebackStatusWithLiterals;
6531
+ customMessage?: string | null;
6532
+ }
6533
+ interface SendRefundEmailResponse {
6534
+ }
6535
+ interface SendFulfillmentEmailRequest {
6536
+ /** @format GUID */
6537
+ orderId?: string;
6538
+ /** @format GUID */
6539
+ fulfillerId?: string;
6540
+ }
6541
+ interface SendFulfillmentEmailResponse {
6542
+ }
6543
+ interface SendMerchantOrderReceivedPushRequest {
6591
6544
  /**
6592
- * External chargeback ID.
6593
- * @format GUID
6594
- * @readonly
6595
- * @immutable
6545
+ * @minLength 1
6546
+ * @maxLength 100
6596
6547
  */
6597
- externalId?: string | null;
6548
+ orderId?: string;
6598
6549
  }
6599
- declare enum ChargebackStatus {
6600
- /** Chargeback was approved. */
6601
- APPROVED = "APPROVED",
6602
- /** Chargeback was reversed. */
6603
- REVERSED = "REVERSED"
6550
+ interface SendMerchantOrderReceivedPushResponse {
6551
+ }
6552
+ interface PreviewEmailByTypeRequest {
6553
+ emailType?: PreviewEmailTypeWithLiterals;
6554
+ }
6555
+ declare enum PreviewEmailType {
6556
+ ORDER_PLACED = "ORDER_PLACED",
6557
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6558
+ ORDER_SHIPPED = "ORDER_SHIPPED",
6559
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6604
6560
  }
6605
6561
  /** @enumType */
6606
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6607
- interface PaymentMethodName {
6562
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6563
+ interface PreviewEmailByTypeResponse {
6564
+ emailPreview?: string;
6565
+ }
6566
+ interface PreviewRefundEmailRequest {
6608
6567
  /**
6609
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6610
- * @maxLength 150
6568
+ * @minLength 1
6569
+ * @maxLength 100
6611
6570
  */
6612
- buyerLanguageName?: string | null;
6571
+ orderId?: string;
6572
+ /** Refund amount */
6573
+ refundAmount?: Price;
6574
+ /** Refund business details */
6575
+ details?: RefundDetails;
6613
6576
  /**
6614
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6615
- *
6616
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6617
- * @maxLength 150
6577
+ * Personal note added to the email (optional)
6578
+ * @minLength 1
6579
+ * @maxLength 1000
6618
6580
  */
6619
- siteLanguageName?: string | null;
6581
+ customMessage?: string | null;
6620
6582
  /**
6621
- * User-provided payment method name.
6622
- *
6623
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6583
+ * Refund ID. (Optional)
6584
+ * @format GUID
6624
6585
  */
6625
- userDefinedName?: UserDefinedPaymentMethodName;
6586
+ refundId?: string | null;
6626
6587
  }
6627
- interface GiftCardPaymentDetails {
6588
+ interface PreviewRefundEmailResponse {
6589
+ emailPreview?: string;
6590
+ }
6591
+ interface PreviewCancelEmailRequest {
6628
6592
  /**
6629
- * Gift card payment ID.
6593
+ * @minLength 1
6630
6594
  * @maxLength 100
6631
6595
  */
6632
- giftCardPaymentId?: string;
6596
+ orderId?: string;
6633
6597
  /**
6634
- * Gift card ID.
6635
- * @internal
6636
- * @deprecated
6598
+ * Personal note added to the email (optional)
6599
+ * @minLength 1
6600
+ * @maxLength 1000
6637
6601
  */
6638
- giftCardId?: string;
6602
+ customMessage?: string | null;
6603
+ }
6604
+ interface PreviewCancelEmailResponse {
6605
+ emailPreview?: string;
6606
+ }
6607
+ interface PreviewCancelRefundEmailRequest {
6639
6608
  /**
6640
- * ID of the app that created the gift card.
6641
- * @format GUID
6609
+ * @minLength 1
6610
+ * @maxLength 100
6642
6611
  */
6643
- appId?: string;
6612
+ orderId?: string;
6644
6613
  /**
6645
- * Whether the gift card is voided.
6646
- * @readonly
6647
- * @deprecated Whether the gift card is voided.
6648
- * @replacedBy payment.status
6649
- * @targetRemovalDate 2026-11-01
6614
+ * Personal note added to the email (optional)
6615
+ * @minLength 1
6616
+ * @maxLength 1000
6650
6617
  */
6651
- voided?: boolean;
6618
+ customMessage?: string | null;
6619
+ /** Refund amount */
6620
+ refundAmount?: Price;
6652
6621
  /**
6653
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6654
- * @maxLength 30
6655
- * @immutable
6622
+ * Refund ID. (Optional)
6623
+ * @format GUID
6656
6624
  */
6657
- obfuscatedCode?: string | null;
6625
+ refundId?: string | null;
6658
6626
  }
6659
- interface MembershipPaymentDetails {
6627
+ interface PreviewCancelRefundEmailResponse {
6628
+ emailPreview?: string;
6629
+ }
6630
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
6631
+ }
6632
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
6633
+ emailPreview?: string;
6634
+ }
6635
+ interface PreviewBuyerConfirmationEmailRequest {
6636
+ }
6637
+ interface PreviewBuyerConfirmationEmailResponse {
6638
+ emailPreview?: string;
6639
+ }
6640
+ interface PreviewBuyerPickupConfirmationEmailRequest {
6641
+ }
6642
+ interface PreviewBuyerPickupConfirmationEmailResponse {
6643
+ emailPreview?: string;
6644
+ }
6645
+ interface PreviewShippingConfirmationEmailRequest {
6646
+ }
6647
+ interface PreviewShippingConfirmationEmailResponse {
6648
+ emailPreview?: string;
6649
+ }
6650
+ interface PreviewResendDownloadLinksEmailRequest {
6651
+ }
6652
+ interface PreviewResendDownloadLinksEmailResponse {
6653
+ emailPreview?: string;
6654
+ }
6655
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6656
+ /** Emitted on a meta site creation. */
6657
+ siteCreated?: SiteCreated;
6658
+ /** Emitted on a meta site transfer completion. */
6659
+ siteTransferred?: SiteTransferred;
6660
+ /** Emitted on a meta site deletion. */
6661
+ siteDeleted?: SiteDeleted;
6662
+ /** Emitted on a meta site restoration. */
6663
+ siteUndeleted?: SiteUndeleted;
6664
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6665
+ sitePublished?: SitePublished;
6666
+ /** Emitted on a meta site unpublish. */
6667
+ siteUnpublished?: SiteUnpublished;
6668
+ /** Emitted when meta site is marked as template. */
6669
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6670
+ /** Emitted when meta site is marked as a WixSite. */
6671
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6672
+ /** Emitted when an application is provisioned (installed). */
6673
+ serviceProvisioned?: ServiceProvisioned;
6674
+ /** Emitted when an application is removed (uninstalled). */
6675
+ serviceRemoved?: ServiceRemoved;
6676
+ /** Emitted when meta site name (URL slug) is changed. */
6677
+ siteRenamedPayload?: SiteRenamed;
6678
+ /** Emitted when meta site was permanently deleted. */
6679
+ hardDeleted?: SiteHardDeleted;
6680
+ /** Emitted on a namespace change. */
6681
+ namespaceChanged?: NamespaceChanged;
6682
+ /** Emitted when Studio is attached. */
6683
+ studioAssigned?: StudioAssigned;
6684
+ /** Emitted when Studio is detached. */
6685
+ studioUnassigned?: StudioUnassigned;
6660
6686
  /**
6661
- * Membership ID.
6662
- * @maxLength 200
6687
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6688
+ * the actual URL.
6689
+ *
6690
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6691
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6663
6692
  */
6664
- membershipId?: string;
6693
+ urlChanged?: SiteUrlChanged;
6694
+ /** Site is marked as PurgedExternally */
6695
+ sitePurgedExternally?: SitePurgedExternally;
6696
+ /** Emitted when Odeditor is attached. */
6697
+ odeditorAssigned?: OdeditorAssigned;
6698
+ /** Emitted when Odeditor is detached. */
6699
+ odeditorUnassigned?: OdeditorUnassigned;
6700
+ /** Emitted when Picasso is attached. */
6701
+ picassoAssigned?: PicassoAssigned;
6702
+ /** Emitted when Picasso is detached. */
6703
+ picassoUnassigned?: PicassoUnassigned;
6704
+ /** Emitted when Wixel is attached. */
6705
+ wixelAssigned?: WixelAssigned;
6706
+ /** Emitted when Wixel is detached. */
6707
+ wixelUnassigned?: WixelUnassigned;
6708
+ /** Emitted when StudioTwo is attached. */
6709
+ studioTwoAssigned?: StudioTwoAssigned;
6710
+ /** Emitted when StudioTwo is detached. */
6711
+ studioTwoUnassigned?: StudioTwoUnassigned;
6712
+ /** Emitted when media from user domain is enabled. */
6713
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6714
+ /** Emitted when media from user domain is disabled. */
6715
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6716
+ /** Emitted when Editorless is attached. */
6717
+ editorlessAssigned?: EditorlessAssigned;
6718
+ /** Emitted when Editorless is detached. */
6719
+ editorlessUnassigned?: EditorlessUnassigned;
6665
6720
  /**
6666
- * ID of the line item this membership applies to.
6667
- * @minLength 1
6668
- * @maxLength 100
6721
+ * A meta site id.
6722
+ * @format GUID
6669
6723
  */
6670
- lineItemId?: string;
6724
+ metaSiteId?: string;
6725
+ /** A meta site version. Monotonically increasing. */
6726
+ version?: string;
6727
+ /** A timestamp of the event. */
6728
+ timestamp?: string;
6671
6729
  /**
6672
- * Payment status.
6673
- * @deprecated Payment status.
6674
- * @replacedBy payment.status
6675
- * @targetRemovalDate 2026-11-01
6730
+ * TODO(meta-site): Change validation once validations are disabled for consumers
6731
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6732
+ * @maxSize 4000
6676
6733
  */
6677
- status?: MembershipPaymentStatusWithLiterals;
6678
- /** Membership name. */
6679
- name?: MembershipName;
6734
+ assets?: Asset[];
6735
+ }
6736
+ /** @oneof */
6737
+ interface MetaSiteSpecialEventPayloadOneOf {
6738
+ /** Emitted on a meta site creation. */
6739
+ siteCreated?: SiteCreated;
6740
+ /** Emitted on a meta site transfer completion. */
6741
+ siteTransferred?: SiteTransferred;
6742
+ /** Emitted on a meta site deletion. */
6743
+ siteDeleted?: SiteDeleted;
6744
+ /** Emitted on a meta site restoration. */
6745
+ siteUndeleted?: SiteUndeleted;
6746
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6747
+ sitePublished?: SitePublished;
6748
+ /** Emitted on a meta site unpublish. */
6749
+ siteUnpublished?: SiteUnpublished;
6750
+ /** Emitted when meta site is marked as template. */
6751
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6752
+ /** Emitted when meta site is marked as a WixSite. */
6753
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6754
+ /** Emitted when an application is provisioned (installed). */
6755
+ serviceProvisioned?: ServiceProvisioned;
6756
+ /** Emitted when an application is removed (uninstalled). */
6757
+ serviceRemoved?: ServiceRemoved;
6758
+ /** Emitted when meta site name (URL slug) is changed. */
6759
+ siteRenamedPayload?: SiteRenamed;
6760
+ /** Emitted when meta site was permanently deleted. */
6761
+ hardDeleted?: SiteHardDeleted;
6762
+ /** Emitted on a namespace change. */
6763
+ namespaceChanged?: NamespaceChanged;
6764
+ /** Emitted when Studio is attached. */
6765
+ studioAssigned?: StudioAssigned;
6766
+ /** Emitted when Studio is detached. */
6767
+ studioUnassigned?: StudioUnassigned;
6680
6768
  /**
6681
- * The transaction ID in the membership system. Can be used to void the transaction.
6682
- * @minLength 1
6683
- * @maxLength 100
6769
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6770
+ * the actual URL.
6771
+ *
6772
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6773
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6684
6774
  */
6685
- externalTransactionId?: string | null;
6775
+ urlChanged?: SiteUrlChanged;
6776
+ /** Site is marked as PurgedExternally */
6777
+ sitePurgedExternally?: SitePurgedExternally;
6778
+ /** Emitted when Odeditor is attached. */
6779
+ odeditorAssigned?: OdeditorAssigned;
6780
+ /** Emitted when Odeditor is detached. */
6781
+ odeditorUnassigned?: OdeditorUnassigned;
6782
+ /** Emitted when Picasso is attached. */
6783
+ picassoAssigned?: PicassoAssigned;
6784
+ /** Emitted when Picasso is detached. */
6785
+ picassoUnassigned?: PicassoUnassigned;
6786
+ /** Emitted when Wixel is attached. */
6787
+ wixelAssigned?: WixelAssigned;
6788
+ /** Emitted when Wixel is detached. */
6789
+ wixelUnassigned?: WixelUnassigned;
6790
+ /** Emitted when StudioTwo is attached. */
6791
+ studioTwoAssigned?: StudioTwoAssigned;
6792
+ /** Emitted when StudioTwo is detached. */
6793
+ studioTwoUnassigned?: StudioTwoUnassigned;
6794
+ /** Emitted when media from user domain is enabled. */
6795
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6796
+ /** Emitted when media from user domain is disabled. */
6797
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6798
+ /** Emitted when Editorless is attached. */
6799
+ editorlessAssigned?: EditorlessAssigned;
6800
+ /** Emitted when Editorless is detached. */
6801
+ editorlessUnassigned?: EditorlessUnassigned;
6802
+ }
6803
+ interface Asset {
6686
6804
  /**
6687
- * Whether the membership is voided.
6688
- * @readonly
6689
- * @deprecated Whether the membership is voided.
6690
- * @replacedBy payment.status
6691
- * @targetRemovalDate 2026-11-01
6805
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6806
+ * @maxLength 36
6692
6807
  */
6693
- voided?: boolean;
6808
+ appDefId?: string;
6694
6809
  /**
6695
- * ID of the application providing this payment option.
6696
- * @format GUID
6810
+ * An instance id. For legacy reasons may be UUID or a string.
6811
+ * @maxLength 200
6697
6812
  */
6698
- providerAppId?: string;
6699
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6700
- futureMembership?: FutureMembershipDetails;
6813
+ instanceId?: string;
6814
+ /** An application state. */
6815
+ state?: StateWithLiterals;
6701
6816
  }
6702
- declare enum MembershipPaymentStatus {
6703
- /** Payment was charged. */
6704
- CHARGED = "CHARGED",
6705
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
6706
- CHARGE_FAILED = "CHARGE_FAILED",
6707
- /** Payment is pending. */
6708
- CHARGE_PENDING = "CHARGE_PENDING",
6709
- /** Payment was voided. */
6710
- VOIDED = "VOIDED"
6817
+ declare enum State {
6818
+ UNKNOWN = "UNKNOWN",
6819
+ ENABLED = "ENABLED",
6820
+ DISABLED = "DISABLED",
6821
+ PENDING = "PENDING",
6822
+ DEMO = "DEMO"
6711
6823
  }
6712
6824
  /** @enumType */
6713
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6714
- interface FutureMembershipDetails {
6825
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6826
+ interface SiteCreated {
6715
6827
  /**
6716
- * ID of the plan line item in the order from which the membership will be created.
6717
- * @format GUID
6828
+ * A template identifier (empty if not created from a template).
6829
+ * @maxLength 36
6718
6830
  */
6719
- lineItemId?: string;
6831
+ originTemplateId?: string;
6720
6832
  /**
6721
- * ID of the benefit the future membership will grant.
6722
- * @maxLength 200
6833
+ * An account id of the owner.
6834
+ * @format GUID
6723
6835
  */
6724
- benefitId?: string;
6725
- }
6726
- interface WixReceiptInfo {
6836
+ ownerId?: string;
6837
+ /** A context in which meta site was created. */
6838
+ context?: SiteCreatedContextWithLiterals;
6727
6839
  /**
6728
- * Receipt ID
6840
+ * A meta site id from which this site was created.
6841
+ *
6842
+ * In case of a creation from a template it's a template id.
6843
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6729
6844
  * @format GUID
6730
6845
  */
6731
- receiptId?: string;
6846
+ originMetaSiteId?: string | null;
6732
6847
  /**
6733
- * Display number of receipt
6734
- * @minLength 1
6735
- * @maxLength 40
6848
+ * A meta site name (URL slug).
6849
+ * @maxLength 20
6736
6850
  */
6737
- displayNumber?: string | null;
6851
+ siteName?: string;
6852
+ /** A namespace. */
6853
+ namespace?: NamespaceWithLiterals;
6738
6854
  }
6739
- interface ExternalReceiptInfo {
6740
- /**
6741
- * External receipt ID
6742
- * @maxLength 100
6743
- */
6744
- receiptId?: string | null;
6855
+ declare enum SiteCreatedContext {
6856
+ /** A valid option, we don't expose all reasons why site might be created. */
6857
+ OTHER = "OTHER",
6858
+ /** A meta site was created from template. */
6859
+ FROM_TEMPLATE = "FROM_TEMPLATE",
6860
+ /** A meta site was created by copying of the transfferred meta site. */
6861
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6862
+ /** A copy of existing meta site. */
6863
+ DUPLICATE = "DUPLICATE",
6864
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6865
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6866
+ /** deprecated A meta site was created for Flash editor. */
6867
+ FLASH = "FLASH"
6868
+ }
6869
+ /** @enumType */
6870
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6871
+ declare enum Namespace {
6872
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6873
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6874
+ WIX = "WIX",
6875
+ /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6876
+ SHOUT_OUT = "SHOUT_OUT",
6877
+ /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6878
+ ALBUMS = "ALBUMS",
6879
+ /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6880
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6881
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6882
+ HOTELS = "HOTELS",
6883
+ /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6884
+ CLUBS = "CLUBS",
6885
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6886
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6745
6887
  /**
6746
- * ID of the app providing the receipt
6747
- * @format GUID
6888
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6889
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6748
6890
  */
6749
- appId?: string | null;
6891
+ DEV_SITE = "DEV_SITE",
6892
+ /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6893
+ LOGOS = "LOGOS",
6894
+ /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6895
+ VIDEO_MAKER = "VIDEO_MAKER",
6896
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6897
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6898
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6899
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6750
6900
  /**
6751
- * Display number of receipt
6752
- * @minLength 1
6753
- * @maxLength 40
6901
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6902
+ *
6903
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
6754
6904
  */
6755
- displayNumber?: string | null;
6756
- }
6757
- interface CashRoundingDetails {
6905
+ HTML_DRAFT = "HTML_DRAFT",
6758
6906
  /**
6759
- * Payment amount before cash rounding was applied.
6760
- * When provided, balance and status calculations use this value instead of `amount`
6761
- * to prevent false overpayment or underpayment due to rounding.
6907
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6908
+ * Will be accessible from Site List and will not have a website app.
6909
+ * Once the user attaches a site, the site will become a regular wixsite.
6762
6910
  */
6763
- unroundedAmount?: Price;
6911
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
6912
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6913
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
6914
+ /** It is to be used in the Business First efforts. */
6915
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
6916
+ /** Bookings business flow with no site. */
6917
+ ANYWHERE = "ANYWHERE",
6918
+ /** Namespace for Headless Backoffice with no editor */
6919
+ HEADLESS = "HEADLESS",
6764
6920
  /**
6765
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6766
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6767
- * @readonly
6921
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6922
+ * The site will be used for account level CSM feature for enterprise
6768
6923
  */
6769
- roundingAdjustment?: CashRounding;
6770
- }
6771
- declare enum PaymentStatus {
6772
- /** Payment was charged successfully. */
6773
- APPROVED = "APPROVED",
6774
- /** Payment is being processed and hasn't been confirmed yet. */
6775
- PENDING = "PENDING",
6776
- /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
6777
- PENDING_MERCHANT = "PENDING_MERCHANT",
6778
- /** Payment was canceled before it was charged. */
6779
- CANCELED = "CANCELED",
6780
- /** Payment was declined by the payment provider. */
6781
- DECLINED = "DECLINED",
6782
- /** Payment was fully refunded. */
6783
- REFUNDED = "REFUNDED",
6784
- /** Part of the payment amount was refunded. */
6785
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6786
- /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
6787
- AUTHORIZED = "AUTHORIZED",
6924
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6925
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6926
+ RISE = "RISE",
6788
6927
  /**
6789
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6790
- *
6791
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6928
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6929
+ * There's a blank site behind the scene but it's blank).
6930
+ * The Mobile company will be the owner of this namespace.
6792
6931
  */
6793
- VOIDED = "VOIDED"
6794
- }
6795
- /** @enumType */
6796
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6797
- interface CanceledStatusDetails {
6798
- reason?: CanceledReasonWithLiterals;
6799
- }
6800
- declare enum CanceledReason {
6801
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
6802
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6803
- /** Payment was not completed by user and expired. */
6804
- EXPIRED = "EXPIRED"
6805
- }
6806
- /** @enumType */
6807
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6808
- interface DeclinedStatusDetails {
6809
- reason?: DeclinedReasonWithLiterals;
6810
- }
6811
- declare enum DeclinedReason {
6812
- /** Corresponding charge failed. */
6813
- CHARGE_FAILED = "CHARGE_FAILED",
6814
- /** Payment details expired. */
6815
- EXPIRED = "EXPIRED",
6816
- /** Insufficient funds. */
6817
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6818
- /** Gift card was disabled before charge was attempted. */
6819
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6820
- }
6821
- /** @enumType */
6822
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6823
- interface VoidedStatusDetails {
6824
- reason?: VoidedReasonWithLiterals;
6825
- }
6826
- declare enum VoidedReason {
6827
- /** Payment was voided by merchant request. */
6828
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6829
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6830
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6831
- }
6832
- /** @enumType */
6833
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6834
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6835
- /** @internal */
6836
- canceled?: CanceledStatusDetails;
6837
- /** @internal */
6838
- declined?: DeclinedStatusDetails;
6839
- /** @internal */
6840
- voided?: VoidedStatusDetails;
6932
+ BRANDED_FIRST = "BRANDED_FIRST",
6933
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6934
+ NOWNIA = "NOWNIA",
6841
6935
  /**
6842
- * Reason code from the payment gateway.
6843
- * @internal
6844
- * @minLength 1
6845
- * @maxLength 10
6936
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
6937
+ * The Partners company owns this namespace.
6846
6938
  */
6847
- paymentGatewayReasonCode?: string | null;
6848
- }
6849
- /** @oneof */
6850
- interface PaymentStatusDetailsStatusDetailsOneOf {
6851
- /** @internal */
6852
- canceled?: CanceledStatusDetails;
6853
- /** @internal */
6854
- declined?: DeclinedStatusDetails;
6855
- /** @internal */
6856
- voided?: VoidedStatusDetails;
6857
- }
6858
- interface Refund {
6939
+ UGC_TEMPLATE = "UGC_TEMPLATE",
6940
+ /** Codux Headless Sites */
6941
+ CODUX = "CODUX",
6942
+ /** Bobb - AI Design Creator. */
6943
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6859
6944
  /**
6860
- * Refund ID.
6861
- * @format GUID
6862
- * @readonly
6945
+ * Shared Blog Site is a unique single site across Enterprise account,
6946
+ * This site will hold all Blog posts related to the Marketing product.
6863
6947
  */
6864
- id?: string;
6948
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6949
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6950
+ STANDALONE_FORMS = "STANDALONE_FORMS",
6951
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6952
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
6953
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6954
+ MIMIR = "MIMIR",
6955
+ /** Wix Twins platform. */
6956
+ TWINS = "TWINS",
6957
+ /** Wix Nano. */
6958
+ NANO = "NANO",
6959
+ /** Base44 headless sites. */
6960
+ BASE44 = "BASE44",
6961
+ /** Wix Channels Sites */
6962
+ CHANNELS = "CHANNELS",
6963
+ /** Nautilus platform. */
6964
+ NAUTILUS = "NAUTILUS",
6865
6965
  /**
6866
- * List of transactions.
6867
- * @maxSize 50
6966
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6967
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6868
6968
  */
6869
- transactions?: RefundTransaction[];
6870
- /** Refund business details. */
6871
- details?: RefundDetails;
6969
+ SYMPHONY = "SYMPHONY",
6970
+ /** Nautilus platform app. */
6971
+ NAUTILUS_APPS = "NAUTILUS_APPS",
6872
6972
  /**
6873
- * Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
6874
- * @readonly
6875
- * @immutable
6973
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6974
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6876
6975
  */
6877
- createdDate?: Date | null;
6976
+ VIBU = "VIBU",
6878
6977
  /**
6879
- * Aggregated refund summary.
6880
- * @readonly
6978
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6979
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
6980
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6981
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
6881
6982
  */
6882
- summary?: AggregatedRefundSummary;
6983
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6883
6984
  /**
6884
- * ID of the app that initiated this refund.
6885
- * @format GUID
6886
- * @readonly
6887
- * @immutable
6985
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
6986
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6888
6987
  */
6889
- requestingServiceAppId?: string | null;
6988
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6890
6989
  }
6891
- interface RefundTransaction {
6990
+ /** @enumType */
6991
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
6992
+ /** Site transferred to another user. */
6993
+ interface SiteTransferred {
6892
6994
  /**
6893
- * ID of the payment associated with this refund.
6995
+ * A previous owner id (user that transfers meta site).
6894
6996
  * @format GUID
6895
- * @immutable
6896
- */
6897
- paymentId?: string;
6898
- /**
6899
- * Refund amount.
6900
- * @immutable
6901
6997
  */
6902
- amount?: Price;
6903
- /** Refund status. */
6904
- refundStatus?: RefundStatusWithLiterals;
6905
- /** Optional details of current refund status. */
6906
- refundStatusInfo?: RefundStatusInfo;
6998
+ oldOwnerId?: string;
6907
6999
  /**
6908
- * Payment gateway's refund ID.
6909
- * This field is only returned when the value of `external_refund` is `false`.
7000
+ * A new owner id (user that accepts meta site).
6910
7001
  * @format GUID
6911
7002
  */
6912
- gatewayRefundId?: string | null;
6913
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6914
- providerRefundId?: string | null;
7003
+ newOwnerId?: string;
7004
+ }
7005
+ /** Soft deletion of the meta site. Could be restored. */
7006
+ interface SiteDeleted {
7007
+ /** A deletion context. */
7008
+ deleteContext?: DeleteContext;
7009
+ }
7010
+ interface DeleteContext {
7011
+ /** When the meta site was deleted. */
7012
+ dateDeleted?: Date | null;
7013
+ /** A status. */
7014
+ deleteStatus?: DeleteStatusWithLiterals;
6915
7015
  /**
6916
- * Whether refund was made externally and manually on the payment provider's side.
6917
- * @immutable
7016
+ * A reason (flow).
7017
+ * @maxLength 255
6918
7018
  */
6919
- externalRefund?: boolean;
7019
+ deleteOrigin?: string;
6920
7020
  /**
6921
- * Location where the refund was processed.
6922
- * @internal
6923
- * @format GUID
6924
- * @immutable
7021
+ * A service that deleted it.
7022
+ * @maxLength 255
6925
7023
  */
6926
- locationId?: string | null;
7024
+ initiatorId?: string | null;
6927
7025
  }
6928
- /** Refund transaction status. */
6929
- declare enum RefundStatus {
6930
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6931
- PENDING = "PENDING",
6932
- /** Refund transaction succeeded. */
6933
- SUCCEEDED = "SUCCEEDED",
6934
- /** Refund transaction failed. */
6935
- FAILED = "FAILED",
6936
- /** Refund request acknowledged, and will be executed soon. */
6937
- SCHEDULED = "SCHEDULED",
6938
- /** Refund was initiated on payment provider side. */
6939
- STARTED = "STARTED"
7026
+ declare enum DeleteStatus {
7027
+ UNKNOWN = "UNKNOWN",
7028
+ TRASH = "TRASH",
7029
+ DELETED = "DELETED",
7030
+ PENDING_PURGE = "PENDING_PURGE",
7031
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6940
7032
  }
6941
7033
  /** @enumType */
6942
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6943
- interface RefundStatusInfo {
6944
- /**
6945
- * Reason code for the refund's current status.
6946
- *
6947
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6948
- * @minLength 1
6949
- * @maxLength 10
6950
- */
6951
- paymentGatewayReasonCode?: string | null;
7034
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
7035
+ /** Restoration of the meta site. */
7036
+ interface SiteUndeleted {
7037
+ }
7038
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
7039
+ interface SitePublished {
7040
+ }
7041
+ interface SiteUnpublished {
6952
7042
  /**
6953
- * Free text explanation of current refund status.
6954
- * @minLength 1
6955
- * @maxLength 1000
7043
+ * A list of URLs previously associated with the meta site.
7044
+ * @maxLength 4000
7045
+ * @maxSize 10000
6956
7046
  */
6957
- description?: string | null;
7047
+ urls?: string[];
6958
7048
  }
6959
- interface AggregatedRefundSummary {
6960
- /** Total amount requested for refund. */
6961
- requestedRefund?: Price;
6962
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6963
- pendingRefund?: Price;
6964
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6965
- refunded?: Price;
6966
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6967
- failedRefundAmount?: Price;
6968
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6969
- pending?: boolean;
6970
- /** Breakdown of refunded items. Available only after refund is complete. */
6971
- breakdown?: RefundItemsBreakdown;
7049
+ interface SiteMarkedAsTemplate {
6972
7050
  }
6973
- interface RefundItemsBreakdown {
7051
+ interface SiteMarkedAsWixSite {
7052
+ }
7053
+ /**
7054
+ * Represents a service provisioned a site.
7055
+ *
7056
+ * Note on `origin_instance_id`:
7057
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
7058
+ * This is because of the following scenario:
7059
+ *
7060
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
7061
+ * such as a product catalog. When you create a site from this template, you inherit this
7062
+ * default product catalog. However, if the template's product catalog is modified,
7063
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
7064
+ * your site remains consistent with what you initially received and does not include any
7065
+ * changes made to the original template afterward.
7066
+ * To ensure this, the TPA on the template gets a new instance_id.
7067
+ */
7068
+ interface ServiceProvisioned {
6974
7069
  /**
6975
- * Refunded line items and the amount refunded for each.
6976
- * @maxSize 300
7070
+ * Either UUID or EmbeddedServiceType.
7071
+ * @maxLength 36
6977
7072
  */
6978
- lineItems?: LineItemRefundSummary[];
6979
- }
6980
- interface LineItemRefundSummary {
7073
+ appDefId?: string;
6981
7074
  /**
6982
- * ID of the refunded line item.
6983
- * @format GUID
7075
+ * Not only UUID. Something here could be something weird.
7076
+ * @maxLength 36
6984
7077
  */
6985
- lineItemId?: string;
6986
- /** Total refunded amount for the line item. */
6987
- totalRefundedAmount?: Price;
6988
- }
6989
- interface CalculateRefundRequest {
7078
+ instanceId?: string;
6990
7079
  /**
6991
- * Order ID
6992
- * @minLength 1
6993
- * @maxLength 100
7080
+ * An instance id from which this instance is originated.
7081
+ * @maxLength 36
6994
7082
  */
6995
- ecomOrderId?: string;
7083
+ originInstanceId?: string;
6996
7084
  /**
6997
- * Refunded line items and quantity
6998
- * @maxSize 300
7085
+ * A version.
7086
+ * @maxLength 500
6999
7087
  */
7000
- refundItems?: CalculateRefundItemRequest[];
7001
- /** Should include shipping in refund calculation */
7002
- refundShipping?: boolean;
7003
- }
7004
- interface CalculateRefundItemRequest {
7088
+ version?: string | null;
7005
7089
  /**
7006
- * ID of the line item being refunded
7090
+ * The origin meta site id
7007
7091
  * @format GUID
7008
7092
  */
7009
- id?: string;
7093
+ originMetaSiteId?: string | null;
7094
+ }
7095
+ interface ServiceRemoved {
7010
7096
  /**
7011
- * How much of that line item is being refunded
7012
- * @min 1
7013
- * @max 100000
7097
+ * Either UUID or EmbeddedServiceType.
7098
+ * @maxLength 36
7014
7099
  */
7015
- quantity?: number;
7016
- }
7017
- interface CalculateRefundResponse {
7018
- /** Total refundable amount */
7019
- total?: Price;
7020
- /** Tax cost of the order */
7021
- tax?: Price;
7022
- /** Discount given for this order */
7023
- discount?: Price;
7024
- /** Total cost of the order (without tax) */
7025
- subtotal?: Price;
7026
- /** Total shipping cost for order */
7027
- shipping?: Price;
7028
- /** Previous refund given on that order */
7029
- previouslyRefundedAmount?: Price;
7100
+ appDefId?: string;
7030
7101
  /**
7031
- * The refundable items of that order
7032
- * @maxSize 300
7102
+ * Not only UUID. Something here could be something weird.
7103
+ * @maxLength 36
7033
7104
  */
7034
- items?: CalculateRefundItemResponse[];
7035
- }
7036
- interface CalculateRefundItemResponse {
7105
+ instanceId?: string;
7037
7106
  /**
7038
- * Line item ID
7039
- * @format GUID
7107
+ * A version.
7108
+ * @maxLength 500
7040
7109
  */
7041
- id?: string;
7042
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
7043
- price?: Price;
7110
+ version?: string | null;
7044
7111
  }
7045
- interface VoidAuthorizedPaymentsRequest {
7112
+ /** Rename of the site. Meaning, free public url has been changed as well. */
7113
+ interface SiteRenamed {
7046
7114
  /**
7047
- * Wix eCommerce order ID
7048
- * @minLength 1
7049
- * @maxLength 100
7115
+ * A new meta site name (URL slug).
7116
+ * @maxLength 20
7050
7117
  */
7051
- ecomOrderId: string;
7118
+ newSiteName?: string;
7052
7119
  /**
7053
- * Payment IDs
7054
- * @minSize 1
7055
- * @maxSize 100
7056
- * @format GUID
7120
+ * A previous meta site name (URL slug).
7121
+ * @maxLength 255
7057
7122
  */
7058
- paymentIds: string[];
7123
+ oldSiteName?: string;
7059
7124
  }
7060
- interface VoidAuthorizedPaymentsResponse {
7061
- /** All order's transactions after the void was triggered */
7062
- orderTransactions?: OrderTransactions;
7125
+ /**
7126
+ * Hard deletion of the meta site.
7127
+ *
7128
+ * Could not be restored. Therefore it's desirable to cleanup data.
7129
+ */
7130
+ interface SiteHardDeleted {
7131
+ /** A deletion context. */
7132
+ deleteContext?: DeleteContext;
7063
7133
  }
7064
- interface CaptureAuthorizedPaymentsRequest {
7065
- /**
7066
- * Wix eCommerce order ID
7067
- * @minLength 1
7068
- * @maxLength 100
7069
- */
7070
- ecomOrderId: string;
7134
+ interface NamespaceChanged {
7135
+ /** A previous namespace. */
7136
+ oldNamespace?: NamespaceWithLiterals;
7137
+ /** A new namespace. */
7138
+ newNamespace?: NamespaceWithLiterals;
7139
+ }
7140
+ /** Assigned Studio editor */
7141
+ interface StudioAssigned {
7142
+ }
7143
+ /** Unassigned Studio editor */
7144
+ interface StudioUnassigned {
7145
+ }
7146
+ /**
7147
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
7148
+ *
7149
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
7150
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
7151
+ *
7152
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
7153
+ */
7154
+ interface SiteUrlChanged {
7155
+ }
7156
+ /**
7157
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
7158
+ * Consumed by other teams to remove relevant data.
7159
+ */
7160
+ interface SitePurgedExternally {
7071
7161
  /**
7072
- * Capture payments information
7073
- * @minSize 1
7162
+ * @maxLength 2048
7074
7163
  * @maxSize 100
7164
+ * @deprecated
7165
+ * @targetRemovalDate 2025-04-15
7075
7166
  */
7076
- payments: PaymentCapture[];
7167
+ appDefId?: string[];
7077
7168
  }
7078
- interface PaymentCapture {
7079
- /**
7080
- * Payment ID
7081
- * @format GUID
7082
- */
7083
- paymentId?: string | null;
7084
- /**
7085
- * Capture amount.
7086
- * If not provided - full authorized amount will be captured.
7087
- */
7088
- amount?: Price;
7169
+ /** Assigned Odeditor */
7170
+ interface OdeditorAssigned {
7089
7171
  }
7090
- interface CaptureAuthorizedPaymentsResponse {
7091
- /** All order's transactions after the capture was triggered */
7092
- orderTransactions?: OrderTransactions;
7172
+ /** Unassigned Odeditor */
7173
+ interface OdeditorUnassigned {
7093
7174
  }
7094
- interface ChargeSavedPaymentMethodRequest {
7095
- /**
7096
- * Ecom Order ID.
7097
- * @minLength 1
7098
- * @maxLength 100
7099
- */
7100
- ecomOrderId?: string;
7101
- /** Amount to be charged */
7102
- amount?: Price;
7175
+ /** Assigned Picasso editor */
7176
+ interface PicassoAssigned {
7103
7177
  }
7104
- interface ChargeSavedPaymentMethodResponse {
7105
- /** Payment gateway's order ID (e.g Wix Payments) */
7106
- paymentGatewayOrderId?: string;
7178
+ /** Unassigned Picasso */
7179
+ interface PicassoUnassigned {
7107
7180
  }
7108
- interface V1TriggerReindexRequest {
7109
- /** @format GUID */
7110
- metasiteId?: string;
7111
- /**
7112
- * @minLength 1
7113
- * @maxLength 100
7114
- * @maxSize 100
7115
- */
7116
- orderIds?: string[];
7181
+ /** Assigned Wixel */
7182
+ interface WixelAssigned {
7117
7183
  }
7118
- interface V1TriggerReindexResponse {
7184
+ /** Unassigned Wixel */
7185
+ interface WixelUnassigned {
7119
7186
  }
7120
- interface V1TriggerReindexOrderRequest {
7121
- /** @format GUID */
7122
- metasiteId?: string;
7123
- /**
7124
- * @minLength 1
7125
- * @maxLength 100
7126
- */
7127
- orderId?: string;
7187
+ /** Assigned StudioTwo */
7188
+ interface StudioTwoAssigned {
7189
+ }
7190
+ /** Unassigned StudioTwo */
7191
+ interface StudioTwoUnassigned {
7192
+ }
7193
+ /** Media from user domain is enabled. */
7194
+ interface UserDomainMediaEnabled {
7195
+ }
7196
+ /** Media from user domain is disabled. */
7197
+ interface UserDomainMediaDisabled {
7198
+ }
7199
+ /** Assigned Editorless */
7200
+ interface EditorlessAssigned {
7201
+ }
7202
+ /** Unassigned Editorless */
7203
+ interface EditorlessUnassigned {
7204
+ }
7205
+ interface HasCustomEmailConfigurationsRequest {
7206
+ }
7207
+ interface HasCustomEmailConfigurationsResponse {
7208
+ hasCustomConfigurations?: boolean;
7209
+ }
7210
+ interface AddToAutomationMigrationPopulationRequest {
7211
+ /** When true, sends custom email configurations to automation system via email */
7212
+ sendCustomEmailConfigs?: boolean;
7213
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
7214
+ origin?: OriginWithLiterals;
7215
+ }
7216
+ declare enum Origin {
7217
+ OPT_IN = "OPT_IN",
7218
+ MIGRATION = "MIGRATION"
7219
+ }
7220
+ /** @enumType */
7221
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
7222
+ interface AddToAutomationMigrationPopulationResponse {
7223
+ success?: boolean;
7224
+ }
7225
+ interface IsInAutomationMigrationPopulationRequest {
7226
+ }
7227
+ interface IsInAutomationMigrationPopulationResponse {
7228
+ inPopulation?: boolean;
7128
7229
  }
7129
7230
  interface DiffmatokyPayload {
7130
7231
  left?: string;
@@ -9358,4 +9459,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
9358
9459
  declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
9359
9460
  declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
9360
9461
 
9361
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CrossBorderAdjustmentUpdate as CrossBorderAdjustmentUpdateOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricing as CrossBorderRepricingOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type PricesRecalculatedForDestination as PricesRecalculatedForDestinationOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
9462
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type CouponDiscountValueOneOf as CouponDiscountValueOneOfOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CrossBorderAdjustmentUpdate as CrossBorderAdjustmentUpdateOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricing as CrossBorderRepricingOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleDiscountValueOneOf as DiscountRuleDiscountValueOneOfOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, DiscountValueType as DiscountValueTypeOriginal, type DiscountValueTypeWithLiterals as DiscountValueTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type PricesRecalculatedForDestination as PricesRecalculatedForDestinationOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };