@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
@@ -2032,6 +2032,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
2032
2032
  merchantDiscount?: MerchantDiscount;
2033
2033
  /** Automatic discount applied by the system based on configured discount rules. */
2034
2034
  discountRule?: DiscountRule;
2035
+ /** Discount type. */
2035
2036
  discountType?: DiscountTypeWithLiterals;
2036
2037
  /**
2037
2038
  * __Deprecated.__ Use `lineItemDiscounts` instead.
@@ -2097,16 +2098,76 @@ declare enum DiscountType {
2097
2098
  /** @enumType */
2098
2099
  type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
2099
2100
  /** Coupon */
2100
- interface Coupon {
2101
+ interface Coupon extends CouponDiscountValueOneOf {
2102
+ /**
2103
+ * Percentage the coupon took off the price. For example, `10.5` for 10.5%.
2104
+ *
2105
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2106
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2107
+ * @internal
2108
+ * @format DECIMAL_VALUE
2109
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2110
+ */
2111
+ percentage?: string;
2101
2112
  /** Coupon ID. */
2102
2113
  _id?: string;
2103
2114
  /** Coupon code. */
2104
2115
  code?: string;
2105
2116
  /** Coupon name. */
2106
2117
  name?: string;
2107
- /** Coupon value. */
2118
+ /** Total amount the coupon took off. */
2108
2119
  amount?: Price;
2120
+ /**
2121
+ * How the coupon's discount is expressed. `percentage` holds the rate of a percentage coupon, and `amount` holds
2122
+ * the total amount the coupon took off, whatever the type.
2123
+ *
2124
+ * Not returned for a free-shipping coupon.
2125
+ * @internal
2126
+ */
2127
+ discountValueType?: DiscountValueTypeWithLiterals;
2128
+ }
2129
+ /** @oneof */
2130
+ interface CouponDiscountValueOneOf {
2131
+ /**
2132
+ * Percentage the coupon took off the price. For example, `10.5` for 10.5%.
2133
+ *
2134
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2135
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2136
+ * @internal
2137
+ * @format DECIMAL_VALUE
2138
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2139
+ */
2140
+ percentage?: string;
2141
+ }
2142
+ /** How a coupon's or discount rule's discount value is expressed. */
2143
+ declare enum DiscountValueType {
2144
+ /**
2145
+ * The discount takes a percentage off the price it applies to.
2146
+ * @documentationMaturity preview
2147
+ * @internal
2148
+ */
2149
+ PERCENTAGE = "PERCENTAGE",
2150
+ /**
2151
+ * The discount takes a fixed amount off the price it applies to.
2152
+ * @documentationMaturity preview
2153
+ * @internal
2154
+ */
2155
+ FIXED_AMOUNT = "FIXED_AMOUNT",
2156
+ /**
2157
+ * The discount sets the price it applies to a fixed amount.
2158
+ * @documentationMaturity preview
2159
+ * @internal
2160
+ */
2161
+ FIXED_PRICE = "FIXED_PRICE",
2162
+ /**
2163
+ * The discount depends on the number of units bought. For example, 3 for $10, or buy 2 get 1 free.
2164
+ * @documentationMaturity preview
2165
+ * @internal
2166
+ */
2167
+ QUANTITY_BASED = "QUANTITY_BASED"
2109
2168
  }
2169
+ /** @enumType */
2170
+ type DiscountValueTypeWithLiterals = DiscountValueType;
2110
2171
  /** Discount applied manually by the merchant through the dashboard. */
2111
2172
  interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
2112
2173
  /** Predefined discount reason. */
@@ -2153,7 +2214,17 @@ declare enum DiscountReason {
2153
2214
  }
2154
2215
  /** @enumType */
2155
2216
  type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
2156
- interface DiscountRule {
2217
+ interface DiscountRule extends DiscountRuleDiscountValueOneOf {
2218
+ /**
2219
+ * Percentage the discount rule took off the price. For example, `10.5` for 10.5%.
2220
+ *
2221
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2222
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2223
+ * @internal
2224
+ * @format DECIMAL_VALUE
2225
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2226
+ */
2227
+ percentage?: string;
2157
2228
  /**
2158
2229
  * Discount rule ID
2159
2230
  * @format GUID
@@ -2161,8 +2232,29 @@ interface DiscountRule {
2161
2232
  _id?: string;
2162
2233
  /** Discount rule name */
2163
2234
  name?: DiscountRuleName;
2164
- /** Discount value. */
2235
+ /** Total amount the discount rule took off. */
2165
2236
  amount?: Price;
2237
+ /**
2238
+ * How the discount rule's discount is expressed. `percentage` holds the rate of a percentage discount rule, and
2239
+ * `amount` holds the total amount the discount rule took off, whatever the type.
2240
+ *
2241
+ * Not returned for a free-shipping discount rule.
2242
+ * @internal
2243
+ */
2244
+ discountValueType?: DiscountValueTypeWithLiterals;
2245
+ }
2246
+ /** @oneof */
2247
+ interface DiscountRuleDiscountValueOneOf {
2248
+ /**
2249
+ * Percentage the discount rule took off the price. For example, `10.5` for 10.5%.
2250
+ *
2251
+ * For a `SPECIFIC_ITEMS` discount, the percentage applies to the price of the discounted units. For a `GLOBAL`
2252
+ * discount, it applies to the order subtotal. Either way, it's the price after any discounts applied earlier.
2253
+ * @internal
2254
+ * @format DECIMAL_VALUE
2255
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
2256
+ */
2257
+ percentage?: string;
2166
2258
  }
2167
2259
  interface DiscountRuleName {
2168
2260
  /**
@@ -2186,6 +2278,15 @@ interface LineItemDiscount {
2186
2278
  _id?: string;
2187
2279
  /** Total discount amount for this line item. */
2188
2280
  totalDiscount?: Price;
2281
+ /**
2282
+ * Number of the line item's units the discount was applied to.
2283
+ *
2284
+ * Returned only for a `SPECIFIC_ITEMS` discount.
2285
+ * @internal
2286
+ * @min 1
2287
+ * @max 100000
2288
+ */
2289
+ discountedQuantity?: number | null;
2189
2290
  }
2190
2291
  interface ItemCombination {
2191
2292
  /**
@@ -4719,2328 +4820,2328 @@ interface BulkDeleteImportedOrdersResponse {
4719
4820
  */
4720
4821
  jobId?: string;
4721
4822
  }
4722
- interface SendBuyerConfirmationEmailRequest {
4823
+ interface V1TriggerReindexRequest {
4723
4824
  /** @format GUID */
4724
- orderId?: string;
4725
- }
4726
- interface SendBuyerConfirmationEmailResponse {
4727
- }
4728
- interface SendBuyerPaymentsReceivedEmailRequest {
4825
+ metasiteId?: string;
4729
4826
  /**
4730
4827
  * @minLength 1
4731
4828
  * @maxLength 100
4829
+ * @maxSize 100
4732
4830
  */
4733
- orderId?: string;
4831
+ orderIds?: string[];
4734
4832
  }
4735
- interface SendBuyerPaymentsReceivedEmailResponse {
4833
+ interface V1TriggerReindexResponse {
4736
4834
  }
4737
- interface SendBuyerPickupConfirmationEmailRequest {
4835
+ interface V1TriggerReindexOrderRequest {
4836
+ /** @format GUID */
4837
+ metasiteId?: string;
4738
4838
  /**
4739
4839
  * @minLength 1
4740
4840
  * @maxLength 100
4741
4841
  */
4742
4842
  orderId?: string;
4743
4843
  }
4744
- interface SendBuyerPickupConfirmationEmailResponse {
4745
- }
4746
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
4747
- /**
4748
- * IDs of orders to send pickup emails for.
4749
- * @minSize 1
4750
- * @maxSize 300
4751
- */
4752
- orderIds?: string[];
4753
- }
4754
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
4755
- }
4756
- interface SendBuyerShippingConfirmationEmailRequest {
4844
+ interface PreparePaymentCollectionRequest {
4757
4845
  /**
4846
+ * Ecom order ID.
4758
4847
  * @minLength 1
4759
4848
  * @maxLength 100
4760
4849
  */
4761
- orderId?: string;
4762
- }
4763
- interface SendBuyerShippingConfirmationEmailResponse {
4764
- }
4765
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
4850
+ ecomOrderId: string;
4851
+ /** Amount to collect */
4852
+ amount: Price;
4766
4853
  /**
4767
- * IDs of orders to send pickup emails for.
4768
- * @minSize 1
4769
- * @maxSize 300
4854
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4855
+ * Existing payment gateway order will be updated with a new amount.
4856
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4770
4857
  */
4771
- orderIds?: string[];
4772
- }
4773
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
4774
- }
4775
- interface SendMerchantOrderReceivedNotificationRequest {
4858
+ paymentGatewayOrderId?: string | null;
4776
4859
  /**
4777
- * @minLength 1
4778
- * @maxLength 100
4860
+ * Whether to delay capture of the payment.
4861
+ * Default: false
4862
+ * @deprecated Whether to delay capture of the payment.
4863
+ * Default: false
4864
+ * @replacedBy delayed_capture_settings.scheduled_action
4865
+ * @targetRemovalDate 2024-09-30
4779
4866
  */
4780
- orderId?: string;
4781
- }
4782
- interface SendMerchantOrderReceivedNotificationResponse {
4783
- }
4784
- interface SendCancelRefundEmailRequest {
4867
+ delayedCapture?: boolean;
4785
4868
  /**
4786
- * The ID of order that is canceled/refunded
4787
- * @minLength 1
4788
- * @maxLength 100
4869
+ * Specifies whether payment collection is initiated by Merchant or User of User
4870
+ * Default: `true`
4871
+ * @internal
4789
4872
  */
4790
- orderId?: string;
4873
+ merchantInitiated?: boolean | null;
4791
4874
  /**
4792
- * Personal note added to the email (optional)
4793
- * @minLength 1
4794
- * @maxLength 1000
4875
+ * Redirect urls which are used to return buyer to third party system.
4876
+ * @internal
4795
4877
  */
4796
- customMessage?: string | null;
4797
- /** Refund amount */
4798
- refundAmount?: Price;
4878
+ redirectUrls?: RedirectUrls;
4879
+ /** Delayed capture payment settings */
4880
+ delayedCaptureSettings?: DelayedCaptureSettings;
4881
+ }
4882
+ interface RedirectUrls {
4799
4883
  /**
4800
- * Refund ID. (Optional)
4801
- * @format GUID
4884
+ * URL to redirect buyer in case of approved (successful) transaction
4885
+ * @format WEB_URL
4802
4886
  */
4803
- refundId?: string | null;
4804
- }
4805
- interface SendCancelRefundEmailResponse {
4806
- }
4807
- interface SendRefundEmailRequest {
4887
+ successUrl?: string | null;
4808
4888
  /**
4809
- * The ID of order that is refunded
4810
- * @format GUID
4889
+ * URL to redirect buyer in case of buyer canceled the transaction
4890
+ * @format WEB_URL
4811
4891
  */
4812
- orderId?: string;
4892
+ cancelUrl?: string | null;
4813
4893
  /**
4814
- * Refund ID
4815
- * @format GUID
4894
+ * URL to redirect buyer in case of failed/rejected transaction
4895
+ * @format WEB_URL
4816
4896
  */
4817
- refundId?: string;
4897
+ errorUrl?: string | null;
4818
4898
  /**
4819
- * Personal note added to the email (optional)
4820
- * @minLength 1
4821
- * @maxLength 1000
4899
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4900
+ * @format WEB_URL
4822
4901
  */
4823
- customMessage?: string | null;
4824
- }
4825
- interface SendRefundEmailResponse {
4902
+ pendingUrl?: string | null;
4826
4903
  }
4827
- interface SendFulfillmentEmailRequest {
4828
- /** @format GUID */
4829
- orderId?: string;
4830
- /** @format GUID */
4831
- fulfillerId?: string;
4904
+ interface DelayedCaptureSettings {
4905
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4906
+ scheduledAction?: ScheduledActionWithLiterals;
4907
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4908
+ delayDuration?: Duration;
4832
4909
  }
4833
- interface SendFulfillmentEmailResponse {
4910
+ declare enum ScheduledAction {
4911
+ /** Whether payment will be auto-voided when duration passes */
4912
+ VOID = "VOID",
4913
+ /** Whether payment will be auto-captured when duration passes */
4914
+ CAPTURE = "CAPTURE"
4834
4915
  }
4835
- interface SendMerchantOrderReceivedPushRequest {
4916
+ /** @enumType */
4917
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4918
+ interface Duration {
4836
4919
  /**
4837
- * @minLength 1
4838
- * @maxLength 100
4920
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4921
+ * @min 1
4839
4922
  */
4840
- orderId?: string;
4841
- }
4842
- interface SendMerchantOrderReceivedPushResponse {
4843
- }
4844
- interface PreviewEmailByTypeRequest {
4845
- emailType?: PreviewEmailTypeWithLiterals;
4923
+ count?: number;
4924
+ /** Duration unit: MINUTES, HOURS and DAYS */
4925
+ unit?: DurationUnitWithLiterals;
4846
4926
  }
4847
- declare enum PreviewEmailType {
4848
- ORDER_PLACED = "ORDER_PLACED",
4849
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4850
- ORDER_SHIPPED = "ORDER_SHIPPED",
4851
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4927
+ declare enum DurationUnit {
4928
+ MINUTES = "MINUTES",
4929
+ HOURS = "HOURS",
4930
+ DAYS = "DAYS"
4852
4931
  }
4853
4932
  /** @enumType */
4854
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4855
- interface PreviewEmailByTypeResponse {
4856
- emailPreview?: string;
4933
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4934
+ interface PreparePaymentCollectionResponse {
4935
+ /** Payment gateway order id which is associated with given payment */
4936
+ paymentGatewayOrderId?: string;
4857
4937
  }
4858
- interface PreviewRefundEmailRequest {
4938
+ interface GetPaymentCollectabilityStatusRequest {
4859
4939
  /**
4940
+ * Ecom order ID.
4860
4941
  * @minLength 1
4861
4942
  * @maxLength 100
4862
4943
  */
4863
- orderId?: string;
4864
- /** Refund amount */
4865
- refundAmount?: Price;
4866
- /** Refund business details */
4867
- details?: RefundDetails;
4944
+ ecomOrderId: string;
4945
+ }
4946
+ interface GetPaymentCollectabilityStatusResponse {
4947
+ /** Payment collectability status */
4948
+ status?: PaymentCollectabilityStatusWithLiterals;
4949
+ /** Collectable order amount */
4950
+ amount?: Price;
4868
4951
  /**
4869
- * Personal note added to the email (optional)
4870
- * @minLength 1
4871
- * @maxLength 1000
4952
+ * Whether authorization supported
4953
+ * @internal
4872
4954
  */
4873
- customMessage?: string | null;
4955
+ authorizationSupported?: boolean;
4874
4956
  /**
4875
- * Refund ID. (Optional)
4876
- * @format GUID
4957
+ * Whether custom amount is supported for payment collection
4958
+ * @internal
4877
4959
  */
4878
- refundId?: string | null;
4960
+ customAmountSupported?: boolean;
4879
4961
  }
4880
- /** Business model of a refund request */
4881
- interface RefundDetails {
4882
- /**
4883
- * Order line item IDs and quantities that were refunded.
4884
- * @maxSize 300
4885
- */
4886
- items?: RefundItem[];
4887
- /** Whether the shipping fee was also refunded. */
4888
- shippingIncluded?: boolean;
4889
- /**
4890
- * Reason for the refund, provided by customer (optional).
4891
- * @maxLength 200
4892
- */
4893
- reason?: string | null;
4894
- /**
4895
- * Line items that were refunded.
4896
- * @maxSize 300
4897
- */
4898
- lineItems?: LineItemRefund[];
4899
- /**
4900
- * Additional fees that were refunded.
4901
- * @maxSize 100
4902
- */
4903
- additionalFees?: AdditionalFeeRefund[];
4904
- /** Shipping amount that was refunded. */
4905
- shipping?: ShippingRefund;
4962
+ declare enum PaymentCollectabilityStatus {
4963
+ UNKNOWN = "UNKNOWN",
4964
+ COLLECTABLE = "COLLECTABLE",
4965
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4966
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4967
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4968
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4969
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4970
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4971
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4972
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4973
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4974
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4975
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4906
4976
  }
4907
- interface RefundItem {
4977
+ /** @enumType */
4978
+ 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';
4979
+ interface RecordManuallyCollectedPaymentRequest {
4908
4980
  /**
4909
- * Line item ID the refunded line item.
4910
- * @format GUID
4981
+ * Order ID.
4982
+ * @minLength 1
4983
+ * @maxLength 100
4911
4984
  */
4912
- lineItemId?: string;
4985
+ orderId: string;
4986
+ /** Amount to be recorded as approved manual payment for given order */
4987
+ amount: Price;
4913
4988
  /**
4914
- * Line item quantity refunded.
4915
- * @min 1
4916
- * @max 100000
4989
+ * Payment method name provided by user.
4990
+ *
4991
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4992
+ * @internal
4917
4993
  */
4918
- quantity?: number;
4994
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4919
4995
  }
4920
- interface LineItemRefund {
4921
- /**
4922
- * Line item ID.
4923
- * @format GUID
4924
- * @immutable
4925
- */
4926
- lineItemId?: string;
4996
+ /**
4997
+ * User-defined payment method name.
4998
+ * Allows specifying either a predefined type or a custom name.
4999
+ */
5000
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5001
+ /** Predefined payment method. */
5002
+ predefined?: PredefinedPaymentMethodWithLiterals;
4927
5003
  /**
4928
- * Refund quantity.
4929
- * @min 1
4930
- * @max 100000
4931
- * @immutable
5004
+ * Custom payment method name provided by user.
5005
+ *
5006
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5007
+ * @minLength 1
5008
+ * @maxLength 150
4932
5009
  */
4933
- quantity?: number;
5010
+ custom?: string | null;
4934
5011
  }
4935
- interface AdditionalFeeRefund {
4936
- /**
4937
- * Additional fee ID.
4938
- * @format GUID
4939
- * @immutable
4940
- */
4941
- additionalFeeId?: string;
5012
+ /** @oneof */
5013
+ interface UserDefinedPaymentMethodNameKindOneOf {
5014
+ /** Predefined payment method. */
5015
+ predefined?: PredefinedPaymentMethodWithLiterals;
4942
5016
  /**
4943
- * Refund amount.
4944
- * @immutable
5017
+ * Custom payment method name provided by user.
5018
+ *
5019
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5020
+ * @minLength 1
5021
+ * @maxLength 150
4945
5022
  */
4946
- amount?: Price;
5023
+ custom?: string | null;
4947
5024
  }
4948
- interface ShippingRefund {
4949
- /**
4950
- * Refund amount.
4951
- * @immutable
4952
- */
4953
- amount?: Price;
5025
+ /** Predefined payment method types for offline/manual payments. */
5026
+ declare enum PredefinedPaymentMethod {
5027
+ /** Cash payment. */
5028
+ CASH = "CASH",
5029
+ /** Bank transfer. */
5030
+ BANK_TRANSFER = "BANK_TRANSFER",
5031
+ /** Payment by check. */
5032
+ CHECK = "CHECK"
4954
5033
  }
4955
- interface PreviewRefundEmailResponse {
4956
- emailPreview?: string;
5034
+ /** @enumType */
5035
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5036
+ interface RecordManuallyCollectedPaymentResponse {
4957
5037
  }
4958
- interface PreviewCancelEmailRequest {
5038
+ interface MarkOrderAsPaidRequest {
4959
5039
  /**
5040
+ * Ecom order ID.
4960
5041
  * @minLength 1
4961
5042
  * @maxLength 100
4962
5043
  */
4963
- orderId?: string;
5044
+ ecomOrderId: string;
4964
5045
  /**
4965
- * Personal note added to the email (optional)
4966
- * @minLength 1
4967
- * @maxLength 1000
5046
+ * Payment method name provided by user.
5047
+ *
5048
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5049
+ * @internal
4968
5050
  */
4969
- customMessage?: string | null;
5051
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4970
5052
  }
4971
- interface PreviewCancelEmailResponse {
4972
- emailPreview?: string;
5053
+ interface MarkOrderAsPaidResponse {
5054
+ /** Updated order. */
5055
+ order?: Order;
4973
5056
  }
4974
- interface PreviewCancelRefundEmailRequest {
5057
+ interface BulkMarkOrdersAsPaidRequest {
4975
5058
  /**
5059
+ * IDs of orders to mark as paid.
5060
+ * @minSize 1
5061
+ * @maxSize 100
4976
5062
  * @minLength 1
4977
5063
  * @maxLength 100
4978
5064
  */
4979
- orderId?: string;
5065
+ ecomOrderIds: string[];
5066
+ }
5067
+ interface BulkMarkOrdersAsPaidResponse {
4980
5068
  /**
4981
- * Personal note added to the email (optional)
4982
- * @minLength 1
4983
- * @maxLength 1000
5069
+ * Items updated by the bulk action.
5070
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4984
5071
  */
4985
- customMessage?: string | null;
4986
- /** Refund amount */
4987
- refundAmount?: Price;
5072
+ results?: BulkOrderResult[];
5073
+ /** Bulk action metadata. */
5074
+ bulkActionMetadata?: BulkActionMetadata;
5075
+ }
5076
+ interface BulkOrderResult {
5077
+ /** Item metadata. */
5078
+ itemMetadata?: ItemMetadata;
4988
5079
  /**
4989
- * Refund ID. (Optional)
4990
- * @format GUID
5080
+ * Updated order.
5081
+ *
5082
+ * Returned when `returnFullEntity = true`.
4991
5083
  */
4992
- refundId?: string | null;
4993
- }
4994
- interface PreviewCancelRefundEmailResponse {
4995
- emailPreview?: string;
4996
- }
4997
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5084
+ item?: Order;
4998
5085
  }
4999
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5000
- emailPreview?: string;
5086
+ interface ItemMetadata {
5087
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5088
+ _id?: string | null;
5089
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5090
+ originalIndex?: number;
5091
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5092
+ success?: boolean;
5093
+ /** Details about the error in case of failure. */
5094
+ error?: ApplicationError;
5001
5095
  }
5002
- interface PreviewBuyerConfirmationEmailRequest {
5096
+ interface ApplicationError {
5097
+ /** Error code. */
5098
+ code?: string;
5099
+ /** Description of the error. */
5100
+ description?: string;
5101
+ /** Data related to the error. */
5102
+ data?: Record<string, any> | null;
5003
5103
  }
5004
- interface PreviewBuyerConfirmationEmailResponse {
5005
- emailPreview?: string;
5104
+ interface BulkActionMetadata {
5105
+ /** Number of items that were successfully processed. */
5106
+ totalSuccesses?: number;
5107
+ /** Number of items that couldn't be processed. */
5108
+ totalFailures?: number;
5109
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5110
+ undetailedFailures?: number;
5006
5111
  }
5007
- interface PreviewBuyerPickupConfirmationEmailRequest {
5112
+ interface GetRefundabilityStatusRequest {
5113
+ /**
5114
+ * Order ID.
5115
+ * @minLength 1
5116
+ * @maxLength 100
5117
+ */
5118
+ ecomOrderId: string;
5008
5119
  }
5009
- interface PreviewBuyerPickupConfirmationEmailResponse {
5010
- emailPreview?: string;
5120
+ interface GetRefundabilityStatusResponse {
5121
+ /**
5122
+ * Refundability details.
5123
+ * @maxSize 300
5124
+ */
5125
+ refundabilities?: Refundability[];
5126
+ /**
5127
+ * Whether the order supports refunding per item.
5128
+ * @deprecated
5129
+ */
5130
+ refundablePerItem?: boolean;
5011
5131
  }
5012
- interface PreviewShippingConfirmationEmailRequest {
5132
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5133
+ /** Reason why payment is not refundable. */
5134
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5135
+ /** Reason why payment is only refundable manually. */
5136
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5137
+ /** Payment ID. */
5138
+ paymentId?: string;
5139
+ /** Payment refundability status. */
5140
+ refundabilityStatus?: RefundableStatusWithLiterals;
5141
+ /** Link to payment provider dashboard. */
5142
+ providerLink?: string | null;
5013
5143
  }
5014
- interface PreviewShippingConfirmationEmailResponse {
5015
- emailPreview?: string;
5144
+ /** @oneof */
5145
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5146
+ /** Reason why payment is not refundable. */
5147
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5148
+ /** Reason why payment is only refundable manually. */
5149
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5016
5150
  }
5017
- interface PreviewResendDownloadLinksEmailRequest {
5151
+ declare enum RefundableStatus {
5152
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5153
+ MANUAL = "MANUAL",
5154
+ REFUNDABLE = "REFUNDABLE"
5018
5155
  }
5019
- interface PreviewResendDownloadLinksEmailResponse {
5020
- emailPreview?: string;
5156
+ /** @enumType */
5157
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5158
+ declare enum NonRefundableReason {
5159
+ NONE = "NONE",
5160
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5161
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5162
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5163
+ NOT_PAID = "NOT_PAID",
5164
+ ACCESS_DENIED = "ACCESS_DENIED",
5165
+ ZERO_PRICE = "ZERO_PRICE",
5166
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5167
+ PENDING_REFUND = "PENDING_REFUND",
5168
+ FORBIDDEN = "FORBIDDEN",
5169
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5170
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5171
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5021
5172
  }
5022
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5023
- /** Emitted on a meta site creation. */
5024
- siteCreated?: SiteCreated;
5025
- /** Emitted on a meta site transfer completion. */
5026
- siteTransferred?: SiteTransferred;
5027
- /** Emitted on a meta site deletion. */
5028
- siteDeleted?: SiteDeleted;
5029
- /** Emitted on a meta site restoration. */
5030
- siteUndeleted?: SiteUndeleted;
5031
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5032
- sitePublished?: SitePublished;
5033
- /** Emitted on a meta site unpublish. */
5034
- siteUnpublished?: SiteUnpublished;
5035
- /** Emitted when meta site is marked as template. */
5036
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5037
- /** Emitted when meta site is marked as a WixSite. */
5038
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5039
- /** Emitted when an application is provisioned (installed). */
5040
- serviceProvisioned?: ServiceProvisioned;
5041
- /** Emitted when an application is removed (uninstalled). */
5042
- serviceRemoved?: ServiceRemoved;
5043
- /** Emitted when meta site name (URL slug) is changed. */
5044
- siteRenamedPayload?: SiteRenamed;
5045
- /** Emitted when meta site was permanently deleted. */
5046
- hardDeleted?: SiteHardDeleted;
5047
- /** Emitted on a namespace change. */
5048
- namespaceChanged?: NamespaceChanged;
5049
- /** Emitted when Studio is attached. */
5050
- studioAssigned?: StudioAssigned;
5051
- /** Emitted when Studio is detached. */
5052
- studioUnassigned?: StudioUnassigned;
5053
- /**
5054
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5055
- * the actual URL.
5056
- *
5057
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5058
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5059
- */
5060
- urlChanged?: SiteUrlChanged;
5061
- /** Site is marked as PurgedExternally */
5062
- sitePurgedExternally?: SitePurgedExternally;
5063
- /** Emitted when Odeditor is attached. */
5064
- odeditorAssigned?: OdeditorAssigned;
5065
- /** Emitted when Odeditor is detached. */
5066
- odeditorUnassigned?: OdeditorUnassigned;
5067
- /** Emitted when Picasso is attached. */
5068
- picassoAssigned?: PicassoAssigned;
5069
- /** Emitted when Picasso is detached. */
5070
- picassoUnassigned?: PicassoUnassigned;
5071
- /** Emitted when Wixel is attached. */
5072
- wixelAssigned?: WixelAssigned;
5073
- /** Emitted when Wixel is detached. */
5074
- wixelUnassigned?: WixelUnassigned;
5075
- /** Emitted when StudioTwo is attached. */
5076
- studioTwoAssigned?: StudioTwoAssigned;
5077
- /** Emitted when StudioTwo is detached. */
5078
- studioTwoUnassigned?: StudioTwoUnassigned;
5079
- /** Emitted when media from user domain is enabled. */
5080
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5081
- /** Emitted when media from user domain is disabled. */
5082
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5083
- /** Emitted when Editorless is attached. */
5084
- editorlessAssigned?: EditorlessAssigned;
5085
- /** Emitted when Editorless is detached. */
5086
- editorlessUnassigned?: EditorlessUnassigned;
5087
- /**
5088
- * A meta site id.
5089
- * @format GUID
5090
- */
5091
- metaSiteId?: string;
5092
- /** A meta site version. Monotonically increasing. */
5093
- version?: string;
5094
- /** A timestamp of the event. */
5095
- timestamp?: string;
5173
+ /** @enumType */
5174
+ 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';
5175
+ declare enum ManuallyRefundableReason {
5176
+ EXPIRED = "EXPIRED",
5177
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5178
+ OFFLINE = "OFFLINE",
5179
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5180
+ }
5181
+ /** @enumType */
5182
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5183
+ interface CreatePaymentGatewayOrderRequest {
5096
5184
  /**
5097
- * TODO(meta-site): Change validation once validations are disabled for consumers
5098
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5099
- * @maxSize 4000
5185
+ * Ecom order ID.
5186
+ * @minLength 1
5187
+ * @maxLength 100
5100
5188
  */
5101
- assets?: Asset[];
5102
- }
5103
- /** @oneof */
5104
- interface MetaSiteSpecialEventPayloadOneOf {
5105
- /** Emitted on a meta site creation. */
5106
- siteCreated?: SiteCreated;
5107
- /** Emitted on a meta site transfer completion. */
5108
- siteTransferred?: SiteTransferred;
5109
- /** Emitted on a meta site deletion. */
5110
- siteDeleted?: SiteDeleted;
5111
- /** Emitted on a meta site restoration. */
5112
- siteUndeleted?: SiteUndeleted;
5113
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5114
- sitePublished?: SitePublished;
5115
- /** Emitted on a meta site unpublish. */
5116
- siteUnpublished?: SiteUnpublished;
5117
- /** Emitted when meta site is marked as template. */
5118
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5119
- /** Emitted when meta site is marked as a WixSite. */
5120
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5121
- /** Emitted when an application is provisioned (installed). */
5122
- serviceProvisioned?: ServiceProvisioned;
5123
- /** Emitted when an application is removed (uninstalled). */
5124
- serviceRemoved?: ServiceRemoved;
5125
- /** Emitted when meta site name (URL slug) is changed. */
5126
- siteRenamedPayload?: SiteRenamed;
5127
- /** Emitted when meta site was permanently deleted. */
5128
- hardDeleted?: SiteHardDeleted;
5129
- /** Emitted on a namespace change. */
5130
- namespaceChanged?: NamespaceChanged;
5131
- /** Emitted when Studio is attached. */
5132
- studioAssigned?: StudioAssigned;
5133
- /** Emitted when Studio is detached. */
5134
- studioUnassigned?: StudioUnassigned;
5189
+ ecomOrderId: string;
5190
+ /** Information about the user who initiated the payment. */
5191
+ chargedBy?: ChargedBy;
5135
5192
  /**
5136
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5137
- * the actual URL.
5193
+ * Whether to delay capture of the payment.
5138
5194
  *
5139
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5140
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5195
+ * Default: false
5196
+ * @internal
5141
5197
  */
5142
- urlChanged?: SiteUrlChanged;
5143
- /** Site is marked as PurgedExternally */
5144
- sitePurgedExternally?: SitePurgedExternally;
5145
- /** Emitted when Odeditor is attached. */
5146
- odeditorAssigned?: OdeditorAssigned;
5147
- /** Emitted when Odeditor is detached. */
5148
- odeditorUnassigned?: OdeditorUnassigned;
5149
- /** Emitted when Picasso is attached. */
5150
- picassoAssigned?: PicassoAssigned;
5151
- /** Emitted when Picasso is detached. */
5152
- picassoUnassigned?: PicassoUnassigned;
5153
- /** Emitted when Wixel is attached. */
5154
- wixelAssigned?: WixelAssigned;
5155
- /** Emitted when Wixel is detached. */
5156
- wixelUnassigned?: WixelUnassigned;
5157
- /** Emitted when StudioTwo is attached. */
5158
- studioTwoAssigned?: StudioTwoAssigned;
5159
- /** Emitted when StudioTwo is detached. */
5160
- studioTwoUnassigned?: StudioTwoUnassigned;
5161
- /** Emitted when media from user domain is enabled. */
5162
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5163
- /** Emitted when media from user domain is disabled. */
5164
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5165
- /** Emitted when Editorless is attached. */
5166
- editorlessAssigned?: EditorlessAssigned;
5167
- /** Emitted when Editorless is detached. */
5168
- editorlessUnassigned?: EditorlessUnassigned;
5198
+ delayedCapture?: boolean;
5169
5199
  }
5170
- interface Asset {
5200
+ interface ChargedBy {
5171
5201
  /**
5172
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5173
- * @maxLength 36
5202
+ * ID - id of the user who initiated the payment
5203
+ * @format GUID
5174
5204
  */
5175
- appDefId?: string;
5205
+ _id?: string;
5176
5206
  /**
5177
- * An instance id. For legacy reasons may be UUID or a string.
5207
+ * Full name - name of the user who initiated the payment
5208
+ * @minLength 1
5178
5209
  * @maxLength 200
5179
5210
  */
5180
- instanceId?: string;
5181
- /** An application state. */
5182
- state?: StateWithLiterals;
5211
+ fullName?: string | null;
5183
5212
  }
5184
- declare enum State {
5185
- UNKNOWN = "UNKNOWN",
5186
- ENABLED = "ENABLED",
5187
- DISABLED = "DISABLED",
5188
- PENDING = "PENDING",
5189
- DEMO = "DEMO"
5213
+ interface CreatePaymentGatewayOrderResponse {
5214
+ /** ID of the order created in the payment gateway */
5215
+ paymentGatewayOrderId?: string;
5190
5216
  }
5191
- /** @enumType */
5192
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5193
- interface SiteCreated {
5194
- /**
5195
- * A template identifier (empty if not created from a template).
5196
- * @maxLength 36
5197
- */
5198
- originTemplateId?: string;
5217
+ interface ChargeMembershipsRequest {
5199
5218
  /**
5200
- * An account id of the owner.
5201
- * @format GUID
5219
+ * Order ID.
5220
+ * @minLength 1
5221
+ * @maxLength 100
5202
5222
  */
5203
- ownerId?: string;
5204
- /** A context in which meta site was created. */
5205
- context?: SiteCreatedContextWithLiterals;
5223
+ ecomOrderId: string;
5206
5224
  /**
5207
- * A meta site id from which this site was created.
5208
- *
5209
- * In case of a creation from a template it's a template id.
5210
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5225
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5226
+ * but a user which is using the membership on behalf of the a member
5211
5227
  * @format GUID
5212
5228
  */
5213
- originMetaSiteId?: string | null;
5229
+ memberId: string;
5214
5230
  /**
5215
- * A meta site name (URL slug).
5216
- * @maxLength 20
5231
+ * List of items to be paid by memberships
5232
+ * @minSize 1
5233
+ * @maxSize 300
5217
5234
  */
5218
- siteName?: string;
5219
- /** A namespace. */
5220
- namespace?: NamespaceWithLiterals;
5221
- }
5222
- declare enum SiteCreatedContext {
5223
- /** A valid option, we don't expose all reasons why site might be created. */
5224
- OTHER = "OTHER",
5225
- /** A meta site was created from template. */
5226
- FROM_TEMPLATE = "FROM_TEMPLATE",
5227
- /** A meta site was created by copying of the transfferred meta site. */
5228
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5229
- /** A copy of existing meta site. */
5230
- DUPLICATE = "DUPLICATE",
5231
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5232
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5233
- /** deprecated A meta site was created for Flash editor. */
5234
- FLASH = "FLASH"
5235
+ membershipCharges?: MembershipChargeItem[];
5235
5236
  }
5236
- /** @enumType */
5237
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5238
- declare enum Namespace {
5239
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5240
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5241
- WIX = "WIX",
5242
- /** 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. */
5243
- SHOUT_OUT = "SHOUT_OUT",
5244
- /** 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. */
5245
- ALBUMS = "ALBUMS",
5246
- /** 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. */
5247
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5248
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5249
- HOTELS = "HOTELS",
5250
- /** 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. */
5251
- CLUBS = "CLUBS",
5252
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5253
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5237
+ interface MembershipChargeItem {
5254
5238
  /**
5255
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5256
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5239
+ * The id of used membership
5240
+ * @minLength 1
5241
+ * @maxLength 100
5257
5242
  */
5258
- DEV_SITE = "DEV_SITE",
5259
- /** 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. */
5260
- LOGOS = "LOGOS",
5261
- /** 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. */
5262
- VIDEO_MAKER = "VIDEO_MAKER",
5263
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5264
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5265
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5266
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5243
+ membershipId?: string;
5267
5244
  /**
5268
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5269
- *
5270
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5245
+ * ID of the application providing this payment option
5246
+ * @format GUID
5271
5247
  */
5272
- HTML_DRAFT = "HTML_DRAFT",
5248
+ appId?: string;
5249
+ /** The name of used membership */
5250
+ membershipName?: MembershipName;
5251
+ /** Additional data about this membership */
5252
+ membershipAdditionalData?: Record<string, any> | null;
5253
+ /** Catalog and item reference info. */
5254
+ catalogReference?: CatalogReference;
5255
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5256
+ serviceProperties?: ServiceProperties;
5273
5257
  /**
5274
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5275
- * Will be accessible from Site List and will not have a website app.
5276
- * Once the user attaches a site, the site will become a regular wixsite.
5258
+ * Usually would be the same as catalogReference.catalogItemId
5259
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5260
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5261
+ * @minLength 1
5262
+ * @maxLength 36
5277
5263
  */
5278
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5279
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5280
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5281
- /** It is to be used in the Business First efforts. */
5282
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5283
- /** Bookings business flow with no site. */
5284
- ANYWHERE = "ANYWHERE",
5285
- /** Namespace for Headless Backoffice with no editor */
5286
- HEADLESS = "HEADLESS",
5287
- /**
5288
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5289
- * The site will be used for account level CSM feature for enterprise
5264
+ rootCatalogItemId?: string | null;
5265
+ /**
5266
+ * line item id of Checkout/Order line item
5267
+ * @minLength 1
5268
+ * @maxLength 100
5290
5269
  */
5291
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5292
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5293
- RISE = "RISE",
5270
+ lineItemId?: string;
5271
+ }
5272
+ interface MembershipName {
5294
5273
  /**
5295
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5296
- * There's a blank site behind the scene but it's blank).
5297
- * The Mobile company will be the owner of this namespace.
5274
+ * Membership name in the site's original language.
5275
+ * @maxLength 100
5298
5276
  */
5299
- BRANDED_FIRST = "BRANDED_FIRST",
5300
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5301
- NOWNIA = "NOWNIA",
5277
+ original?: string;
5302
5278
  /**
5303
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5304
- * The Partners company owns this namespace.
5279
+ * Membership name translated into the buyer's language.
5280
+ *
5281
+ * Default: The value of `original`
5282
+ * @maxLength 100
5305
5283
  */
5306
- UGC_TEMPLATE = "UGC_TEMPLATE",
5307
- /** Codux Headless Sites */
5308
- CODUX = "CODUX",
5309
- /** Bobb - AI Design Creator. */
5310
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5284
+ translated?: string | null;
5285
+ }
5286
+ interface ChargeMembershipsResponse {
5287
+ }
5288
+ interface TriggerRefundRequest {
5311
5289
  /**
5312
- * Shared Blog Site is a unique single site across Enterprise account,
5313
- * This site will hold all Blog posts related to the Marketing product.
5290
+ * The order this refund related to
5291
+ * @minLength 1
5292
+ * @maxLength 100
5314
5293
  */
5315
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5316
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5317
- STANDALONE_FORMS = "STANDALONE_FORMS",
5318
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5319
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5320
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5321
- MIMIR = "MIMIR",
5322
- /** Wix Twins platform. */
5323
- TWINS = "TWINS",
5324
- /** Wix Nano. */
5325
- NANO = "NANO",
5326
- /** Base44 headless sites. */
5327
- BASE44 = "BASE44",
5328
- /** Wix Channels Sites */
5329
- CHANNELS = "CHANNELS",
5330
- /** Nautilus platform. */
5331
- NAUTILUS = "NAUTILUS",
5294
+ ecomOrderId: string;
5332
5295
  /**
5333
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5334
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5296
+ * Refund operations information
5297
+ * @minSize 1
5298
+ * @maxSize 1
5335
5299
  */
5336
- SYMPHONY = "SYMPHONY",
5337
- /** Nautilus platform app. */
5338
- NAUTILUS_APPS = "NAUTILUS_APPS",
5300
+ payments: PaymentRefund[];
5301
+ /** Business model of a refund */
5302
+ details?: RefundDetails;
5303
+ /** Side effect details related to refund */
5304
+ sideEffects?: RefundSideEffects;
5305
+ }
5306
+ interface PaymentRefund {
5339
5307
  /**
5340
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5341
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5308
+ * Specific payment within the order to refund
5309
+ * @format GUID
5342
5310
  */
5343
- VIBU = "VIBU",
5311
+ paymentId?: string;
5312
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5313
+ amount?: Price;
5344
5314
  /**
5345
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5346
- * (an Enterprise account may have several), holding that BrandKit's brand definition
5347
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5348
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
5315
+ * Whether refund is made externally and manually (on the payment provider's side)
5316
+ * 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.
5317
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5349
5318
  */
5350
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5319
+ externalRefund?: boolean;
5351
5320
  /**
5352
- * Dev-center development sites (com.wixpress.devcenter.dsm).
5353
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5321
+ * Gateway refund id. When param is present, new refund is not created.
5322
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5323
+ * and all side effects from request will be executed.
5324
+ * @internal
5325
+ * @minLength 1
5326
+ * @maxLength 100
5354
5327
  */
5355
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5328
+ gatewayRefundId?: string | null;
5356
5329
  }
5357
- /** @enumType */
5358
- 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';
5359
- /** Site transferred to another user. */
5360
- interface SiteTransferred {
5330
+ /** Business model of a refund request */
5331
+ interface RefundDetails {
5361
5332
  /**
5362
- * A previous owner id (user that transfers meta site).
5363
- * @format GUID
5333
+ * Order line item IDs and quantities that were refunded.
5334
+ * @maxSize 300
5364
5335
  */
5365
- oldOwnerId?: string;
5336
+ items?: RefundItem[];
5337
+ /** Whether the shipping fee was also refunded. */
5338
+ shippingIncluded?: boolean;
5366
5339
  /**
5367
- * A new owner id (user that accepts meta site).
5368
- * @format GUID
5340
+ * Reason for the refund, provided by customer (optional).
5341
+ * @maxLength 200
5369
5342
  */
5370
- newOwnerId?: string;
5371
- }
5372
- /** Soft deletion of the meta site. Could be restored. */
5373
- interface SiteDeleted {
5374
- /** A deletion context. */
5375
- deleteContext?: DeleteContext;
5376
- }
5377
- interface DeleteContext {
5378
- /** When the meta site was deleted. */
5379
- dateDeleted?: Date | null;
5380
- /** A status. */
5381
- deleteStatus?: DeleteStatusWithLiterals;
5343
+ reason?: string | null;
5382
5344
  /**
5383
- * A reason (flow).
5384
- * @maxLength 255
5345
+ * Line items that were refunded.
5346
+ * @maxSize 300
5385
5347
  */
5386
- deleteOrigin?: string;
5348
+ lineItems?: LineItemRefund[];
5387
5349
  /**
5388
- * A service that deleted it.
5389
- * @maxLength 255
5350
+ * Additional fees that were refunded.
5351
+ * @maxSize 100
5390
5352
  */
5391
- initiatorId?: string | null;
5392
- }
5393
- declare enum DeleteStatus {
5394
- UNKNOWN = "UNKNOWN",
5395
- TRASH = "TRASH",
5396
- DELETED = "DELETED",
5397
- PENDING_PURGE = "PENDING_PURGE",
5398
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5399
- }
5400
- /** @enumType */
5401
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5402
- /** Restoration of the meta site. */
5403
- interface SiteUndeleted {
5404
- }
5405
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5406
- interface SitePublished {
5353
+ additionalFees?: AdditionalFeeRefund[];
5354
+ /** Shipping amount that was refunded. */
5355
+ shipping?: ShippingRefund;
5407
5356
  }
5408
- interface SiteUnpublished {
5357
+ interface RefundItem {
5409
5358
  /**
5410
- * A list of URLs previously associated with the meta site.
5411
- * @maxLength 4000
5412
- * @maxSize 10000
5359
+ * Line item ID the refunded line item.
5360
+ * @format GUID
5413
5361
  */
5414
- urls?: string[];
5415
- }
5416
- interface SiteMarkedAsTemplate {
5417
- }
5418
- interface SiteMarkedAsWixSite {
5362
+ lineItemId?: string;
5363
+ /**
5364
+ * Line item quantity refunded.
5365
+ * @min 1
5366
+ * @max 100000
5367
+ */
5368
+ quantity?: number;
5419
5369
  }
5420
- /**
5421
- * Represents a service provisioned a site.
5422
- *
5423
- * Note on `origin_instance_id`:
5424
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5425
- * This is because of the following scenario:
5426
- *
5427
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5428
- * such as a product catalog. When you create a site from this template, you inherit this
5429
- * default product catalog. However, if the template's product catalog is modified,
5430
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5431
- * your site remains consistent with what you initially received and does not include any
5432
- * changes made to the original template afterward.
5433
- * To ensure this, the TPA on the template gets a new instance_id.
5434
- */
5435
- interface ServiceProvisioned {
5370
+ interface LineItemRefund {
5436
5371
  /**
5437
- * Either UUID or EmbeddedServiceType.
5438
- * @maxLength 36
5372
+ * Line item ID.
5373
+ * @format GUID
5374
+ * @immutable
5439
5375
  */
5440
- appDefId?: string;
5376
+ lineItemId?: string;
5441
5377
  /**
5442
- * Not only UUID. Something here could be something weird.
5443
- * @maxLength 36
5378
+ * Refund quantity.
5379
+ * @min 1
5380
+ * @max 100000
5381
+ * @immutable
5444
5382
  */
5445
- instanceId?: string;
5383
+ quantity?: number;
5384
+ }
5385
+ interface AdditionalFeeRefund {
5446
5386
  /**
5447
- * An instance id from which this instance is originated.
5448
- * @maxLength 36
5387
+ * Additional fee ID.
5388
+ * @format GUID
5389
+ * @immutable
5449
5390
  */
5450
- originInstanceId?: string;
5391
+ additionalFeeId?: string;
5451
5392
  /**
5452
- * A version.
5453
- * @maxLength 500
5393
+ * Refund amount.
5394
+ * @immutable
5454
5395
  */
5455
- version?: string | null;
5396
+ amount?: Price;
5397
+ }
5398
+ interface ShippingRefund {
5456
5399
  /**
5457
- * The origin meta site id
5458
- * @format GUID
5400
+ * Refund amount.
5401
+ * @immutable
5459
5402
  */
5460
- originMetaSiteId?: string | null;
5403
+ amount?: Price;
5461
5404
  }
5462
- interface ServiceRemoved {
5405
+ interface RefundSideEffects {
5406
+ /** Inventory restock details as part of this refund. */
5407
+ restockInfo?: RestockInfo;
5408
+ /** Whether to send a refund confirmation email to the customer. */
5409
+ sendOrderRefundedEmail?: boolean;
5463
5410
  /**
5464
- * Either UUID or EmbeddedServiceType.
5465
- * @maxLength 36
5411
+ * Custom message added to the refund confirmation email.
5412
+ * @minLength 1
5413
+ * @maxLength 1000
5466
5414
  */
5467
- appDefId?: string;
5415
+ customMessage?: string | null;
5416
+ }
5417
+ interface RestockInfo {
5418
+ /** Restock type. */
5419
+ type?: RestockTypeWithLiterals;
5468
5420
  /**
5469
- * Not only UUID. Something here could be something weird.
5470
- * @maxLength 36
5421
+ * Deprecated, use items instead
5422
+ * @internal
5423
+ * @maxSize 300
5424
+ * @deprecated
5471
5425
  */
5472
- instanceId?: string;
5426
+ lineItemIds?: string[];
5473
5427
  /**
5474
- * A version.
5475
- * @maxLength 500
5428
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5429
+ * @maxSize 300
5476
5430
  */
5477
- version?: string | null;
5431
+ items?: RestockItem[];
5478
5432
  }
5479
- /** Rename of the site. Meaning, free public url has been changed as well. */
5480
- interface SiteRenamed {
5433
+ declare enum RestockType {
5434
+ NO_ITEMS = "NO_ITEMS",
5435
+ ALL_ITEMS = "ALL_ITEMS",
5436
+ SOME_ITEMS = "SOME_ITEMS"
5437
+ }
5438
+ /** @enumType */
5439
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5440
+ interface RestockItem {
5481
5441
  /**
5482
- * A new meta site name (URL slug).
5483
- * @maxLength 20
5442
+ * ID of the line item being restocked.
5443
+ * @format GUID
5484
5444
  */
5485
- newSiteName?: string;
5445
+ lineItemId?: string;
5486
5446
  /**
5487
- * A previous meta site name (URL slug).
5488
- * @maxLength 255
5447
+ * Line item quantity being restocked.
5448
+ * @min 1
5449
+ * @max 100000
5489
5450
  */
5490
- oldSiteName?: string;
5491
- }
5492
- /**
5493
- * Hard deletion of the meta site.
5494
- *
5495
- * Could not be restored. Therefore it's desirable to cleanup data.
5496
- */
5497
- interface SiteHardDeleted {
5498
- /** A deletion context. */
5499
- deleteContext?: DeleteContext;
5500
- }
5501
- interface NamespaceChanged {
5502
- /** A previous namespace. */
5503
- oldNamespace?: NamespaceWithLiterals;
5504
- /** A new namespace. */
5505
- newNamespace?: NamespaceWithLiterals;
5506
- }
5507
- /** Assigned Studio editor */
5508
- interface StudioAssigned {
5451
+ quantity?: number;
5452
+ /**
5453
+ * Per-location breakdown of restock quantities.
5454
+ * @internal
5455
+ * @maxSize 5
5456
+ */
5457
+ restockLocations?: RestockLocation[];
5509
5458
  }
5510
- /** Unassigned Studio editor */
5511
- interface StudioUnassigned {
5459
+ interface TriggerRefundResponse {
5460
+ /** All order's transactions after the refunds were added */
5461
+ orderTransactions?: OrderTransactions;
5462
+ /** Created refund ID */
5463
+ refundId?: string | null;
5464
+ /** Payment ID's that the refund execution had failed for */
5465
+ failedPaymentIds?: ItemMetadata[];
5512
5466
  }
5513
5467
  /**
5514
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5515
- *
5516
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5517
- * with sites and its urls, you need to listen to another topic/event. Read about it:
5468
+ * A record of all payments and refunds associated with an order.
5518
5469
  *
5519
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5520
- */
5521
- interface SiteUrlChanged {
5522
- }
5523
- /**
5524
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5525
- * Consumed by other teams to remove relevant data.
5470
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5526
5471
  */
5527
- interface SitePurgedExternally {
5528
- /**
5529
- * @maxLength 2048
5530
- * @maxSize 100
5531
- * @deprecated
5532
- * @targetRemovalDate 2025-04-15
5533
- */
5534
- appDefId?: string[];
5535
- }
5536
- /** Assigned Odeditor */
5537
- interface OdeditorAssigned {
5538
- }
5539
- /** Unassigned Odeditor */
5540
- interface OdeditorUnassigned {
5541
- }
5542
- /** Assigned Picasso editor */
5543
- interface PicassoAssigned {
5544
- }
5545
- /** Unassigned Picasso */
5546
- interface PicassoUnassigned {
5547
- }
5548
- /** Assigned Wixel */
5549
- interface WixelAssigned {
5550
- }
5551
- /** Unassigned Wixel */
5552
- interface WixelUnassigned {
5553
- }
5554
- /** Assigned StudioTwo */
5555
- interface StudioTwoAssigned {
5556
- }
5557
- /** Unassigned StudioTwo */
5558
- interface StudioTwoUnassigned {
5559
- }
5560
- /** Media from user domain is enabled. */
5561
- interface UserDomainMediaEnabled {
5562
- }
5563
- /** Media from user domain is disabled. */
5564
- interface UserDomainMediaDisabled {
5565
- }
5566
- /** Assigned Editorless */
5567
- interface EditorlessAssigned {
5568
- }
5569
- /** Unassigned Editorless */
5570
- interface EditorlessUnassigned {
5571
- }
5572
- interface HasCustomEmailConfigurationsRequest {
5573
- }
5574
- interface HasCustomEmailConfigurationsResponse {
5575
- hasCustomConfigurations?: boolean;
5576
- }
5577
- interface AddToAutomationMigrationPopulationRequest {
5578
- /** When true, sends custom email configurations to automation system via email */
5579
- sendCustomEmailConfigs?: boolean;
5580
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5581
- origin?: OriginWithLiterals;
5582
- }
5583
- declare enum Origin {
5584
- OPT_IN = "OPT_IN",
5585
- MIGRATION = "MIGRATION"
5586
- }
5587
- /** @enumType */
5588
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5589
- interface AddToAutomationMigrationPopulationResponse {
5590
- success?: boolean;
5591
- }
5592
- interface IsInAutomationMigrationPopulationRequest {
5593
- }
5594
- interface IsInAutomationMigrationPopulationResponse {
5595
- inPopulation?: boolean;
5596
- }
5597
- interface PreparePaymentCollectionRequest {
5472
+ interface OrderTransactions {
5598
5473
  /**
5599
- * Ecom order ID.
5600
- * @minLength 1
5601
- * @maxLength 100
5474
+ * Order ID.
5475
+ * @format GUID
5602
5476
  */
5603
- ecomOrderId: string;
5604
- /** Amount to collect */
5605
- amount: Price;
5477
+ orderId?: string;
5606
5478
  /**
5607
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5608
- * Existing payment gateway order will be updated with a new amount.
5609
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
5479
+ * Record of payments made to the merchant.
5480
+ * @maxSize 100
5610
5481
  */
5611
- paymentGatewayOrderId?: string | null;
5482
+ payments?: Payment[];
5612
5483
  /**
5613
- * Whether to delay capture of the payment.
5614
- * Default: false
5615
- * @deprecated Whether to delay capture of the payment.
5616
- * Default: false
5617
- * @replacedBy delayed_capture_settings.scheduled_action
5618
- * @targetRemovalDate 2024-09-30
5484
+ * Record of refunds made to the buyer.
5485
+ * @maxSize 300
5619
5486
  */
5620
- delayedCapture?: boolean;
5487
+ refunds?: Refund[];
5488
+ }
5489
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5490
+ /** Regular payment details. */
5491
+ regularPaymentDetails?: RegularPaymentDetails;
5492
+ /** Gift card payment details. */
5493
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5494
+ /** Membership payment details. */
5495
+ membershipPaymentDetails?: MembershipPaymentDetails;
5621
5496
  /**
5622
- * Specifies whether payment collection is initiated by Merchant or User of User
5623
- * Default: `true`
5497
+ * Receipt created by Wix
5624
5498
  * @internal
5625
5499
  */
5626
- merchantInitiated?: boolean | null;
5500
+ wixReceipt?: WixReceiptInfo;
5627
5501
  /**
5628
- * Redirect urls which are used to return buyer to third party system.
5502
+ * Receipt created by an external system.
5629
5503
  * @internal
5630
5504
  */
5631
- redirectUrls?: RedirectUrls;
5632
- /** Delayed capture payment settings */
5633
- delayedCaptureSettings?: DelayedCaptureSettings;
5634
- }
5635
- interface RedirectUrls {
5505
+ externalReceipt?: ExternalReceiptInfo;
5506
+ /** @internal */
5507
+ canceled?: CanceledStatusDetails;
5508
+ /** @internal */
5509
+ declined?: DeclinedStatusDetails;
5510
+ /** @internal */
5511
+ voided?: VoidedStatusDetails;
5636
5512
  /**
5637
- * URL to redirect buyer in case of approved (successful) transaction
5638
- * @format WEB_URL
5513
+ * Payment ID.
5514
+ * @format GUID
5515
+ * @readonly
5639
5516
  */
5640
- successUrl?: string | null;
5517
+ _id?: string | null;
5518
+ /** 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. */
5519
+ _createdDate?: Date | null;
5641
5520
  /**
5642
- * URL to redirect buyer in case of buyer canceled the transaction
5643
- * @format WEB_URL
5521
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5522
+ * @readonly
5644
5523
  */
5645
- cancelUrl?: string | null;
5524
+ _updatedDate?: Date | null;
5525
+ /** Payment amount. */
5526
+ amount?: Price;
5646
5527
  /**
5647
- * URL to redirect buyer in case of failed/rejected transaction
5648
- * @format WEB_URL
5528
+ * Whether refunds for this payment are disabled.
5529
+ * + `true`: This payment is not refundable.
5530
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5649
5531
  */
5650
- errorUrl?: string | null;
5532
+ refundDisabled?: boolean;
5651
5533
  /**
5652
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
5653
- * @format WEB_URL
5534
+ * Whether receipt generation is allowed for this payment.
5535
+ * + `true`: This payment supports receipt generation.
5536
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5537
+ * @readonly
5654
5538
  */
5655
- pendingUrl?: string | null;
5656
- }
5657
- interface DelayedCaptureSettings {
5658
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5659
- scheduledAction?: ScheduledActionWithLiterals;
5660
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
5661
- delayDuration?: Duration;
5662
- }
5663
- declare enum ScheduledAction {
5664
- /** Whether payment will be auto-voided when duration passes */
5665
- VOID = "VOID",
5666
- /** Whether payment will be auto-captured when duration passes */
5667
- CAPTURE = "CAPTURE"
5668
- }
5669
- /** @enumType */
5670
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5671
- interface Duration {
5539
+ supportReceiptGeneration?: boolean;
5540
+ /** Details about cash rounding applied to this payment, when relevant. */
5541
+ cashRounding?: CashRoundingDetails;
5542
+ /**
5543
+ * Overall payment status.
5544
+ *
5545
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5546
+ */
5547
+ status?: PaymentStatusWithLiterals;
5672
5548
  /**
5673
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5674
- * @min 1
5549
+ * Detailed payment status information including gateway reason codes and status-specific details.
5550
+ * @internal
5675
5551
  */
5676
- count?: number;
5677
- /** Duration unit: MINUTES, HOURS and DAYS */
5678
- unit?: DurationUnitWithLiterals;
5679
- }
5680
- declare enum DurationUnit {
5681
- MINUTES = "MINUTES",
5682
- HOURS = "HOURS",
5683
- DAYS = "DAYS"
5684
- }
5685
- /** @enumType */
5686
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5687
- interface PreparePaymentCollectionResponse {
5688
- /** Payment gateway order id which is associated with given payment */
5689
- paymentGatewayOrderId?: string;
5690
- }
5691
- interface GetPaymentCollectabilityStatusRequest {
5552
+ paymentStatusDetails?: PaymentStatusDetails;
5692
5553
  /**
5693
- * Ecom order ID.
5694
- * @minLength 1
5695
- * @maxLength 100
5554
+ * Location where the payment was processed.
5555
+ * @internal
5556
+ * @format GUID
5557
+ * @immutable
5696
5558
  */
5697
- ecomOrderId: string;
5559
+ locationId?: string | null;
5560
+ /**
5561
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5562
+ * @format GUID
5563
+ */
5564
+ chargeCorrelationId?: string | null;
5698
5565
  }
5699
- interface GetPaymentCollectabilityStatusResponse {
5700
- /** Payment collectability status */
5701
- status?: PaymentCollectabilityStatusWithLiterals;
5702
- /** Collectable order amount */
5703
- amount?: Price;
5566
+ /** @oneof */
5567
+ interface PaymentPaymentDetailsOneOf {
5568
+ /** Regular payment details. */
5569
+ regularPaymentDetails?: RegularPaymentDetails;
5570
+ /** Gift card payment details. */
5571
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5572
+ /** Membership payment details. */
5573
+ membershipPaymentDetails?: MembershipPaymentDetails;
5574
+ }
5575
+ /** @oneof */
5576
+ interface PaymentReceiptInfoOneOf {
5704
5577
  /**
5705
- * Whether authorization supported
5578
+ * Receipt created by Wix
5706
5579
  * @internal
5707
5580
  */
5708
- authorizationSupported?: boolean;
5581
+ wixReceipt?: WixReceiptInfo;
5709
5582
  /**
5710
- * Whether custom amount is supported for payment collection
5583
+ * Receipt created by an external system.
5711
5584
  * @internal
5712
5585
  */
5713
- customAmountSupported?: boolean;
5586
+ externalReceipt?: ExternalReceiptInfo;
5714
5587
  }
5715
- declare enum PaymentCollectabilityStatus {
5716
- UNKNOWN = "UNKNOWN",
5717
- COLLECTABLE = "COLLECTABLE",
5718
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5719
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5720
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5721
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5722
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5723
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5724
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5725
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5726
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5727
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5728
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5588
+ /** @oneof */
5589
+ interface PaymentStatusDetailsOneOf {
5590
+ /** @internal */
5591
+ canceled?: CanceledStatusDetails;
5592
+ /** @internal */
5593
+ declined?: DeclinedStatusDetails;
5594
+ /** @internal */
5595
+ voided?: VoidedStatusDetails;
5729
5596
  }
5730
- /** @enumType */
5731
- 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';
5732
- interface RecordManuallyCollectedPaymentRequest {
5597
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5598
+ /** Credit card details. */
5599
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5733
5600
  /**
5734
- * Order ID.
5735
- * @minLength 1
5601
+ * Wix Payments order ID.
5736
5602
  * @maxLength 100
5737
5603
  */
5738
- orderId: string;
5739
- /** Amount to be recorded as approved manual payment for given order */
5740
- amount: Price;
5604
+ paymentOrderId?: string | null;
5741
5605
  /**
5742
- * Payment method name provided by user.
5743
- *
5744
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5745
- * @internal
5606
+ * Payment gateway's transaction ID.
5607
+ * This field is only returned when the value of `offline_payment` is `false`.
5608
+ * @maxLength 100
5746
5609
  */
5747
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5748
- }
5749
- /**
5750
- * User-defined payment method name.
5751
- * Allows specifying either a predefined type or a custom name.
5752
- */
5753
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5754
- /** Predefined payment method. */
5755
- predefined?: PredefinedPaymentMethodWithLiterals;
5610
+ gatewayTransactionId?: string | null;
5756
5611
  /**
5757
- * Custom payment method name provided by user.
5758
- *
5759
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5760
- * @minLength 1
5612
+ * Payment method.
5613
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5614
+ * Non-exhaustive list of supported values:
5615
+ * + `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`
5761
5616
  * @maxLength 150
5617
+ * @deprecated Payment method.
5618
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5619
+ * Non-exhaustive list of supported values:
5620
+ * + `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`
5621
+ * @replacedBy payment_method_name
5622
+ * @targetRemovalDate 2026-07-01
5762
5623
  */
5763
- custom?: string | null;
5764
- }
5765
- /** @oneof */
5766
- interface UserDefinedPaymentMethodNameKindOneOf {
5767
- /** Predefined payment method. */
5768
- predefined?: PredefinedPaymentMethodWithLiterals;
5624
+ paymentMethod?: string | null;
5769
5625
  /**
5770
- * Custom payment method name provided by user.
5771
- *
5772
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5773
- * @minLength 1
5774
- * @maxLength 150
5626
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5627
+ * @maxLength 100
5775
5628
  */
5776
- custom?: string | null;
5777
- }
5778
- /** Predefined payment method types for offline/manual payments. */
5779
- declare enum PredefinedPaymentMethod {
5780
- /** Cash payment. */
5781
- CASH = "CASH",
5782
- /** Bank transfer. */
5783
- BANK_TRANSFER = "BANK_TRANSFER",
5784
- /** Payment by check. */
5785
- CHECK = "CHECK"
5786
- }
5787
- /** @enumType */
5788
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5789
- interface RecordManuallyCollectedPaymentResponse {
5790
- }
5791
- interface MarkOrderAsPaidRequest {
5629
+ providerTransactionId?: string | null;
5630
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5631
+ offlinePayment?: boolean;
5792
5632
  /**
5793
- * Ecom order ID.
5794
- * @minLength 1
5795
- * @maxLength 100
5633
+ * Payment status.
5634
+ * @deprecated Payment status.
5635
+ * @replacedBy payment.status
5636
+ * @targetRemovalDate 2026-11-01
5796
5637
  */
5797
- ecomOrderId: string;
5638
+ status?: TransactionStatusWithLiterals;
5639
+ /** Whether there is a payment agreement that allows for future charges. */
5640
+ savedPaymentMethod?: boolean;
5641
+ /** Authorization details. */
5642
+ authorizationDetails?: AuthorizationDetails;
5798
5643
  /**
5799
- * Payment method name provided by user.
5800
- *
5801
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5644
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5802
5645
  * @internal
5646
+ * @maxLength 300
5803
5647
  */
5804
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5805
- }
5806
- interface MarkOrderAsPaidResponse {
5807
- /** Updated order. */
5808
- order?: Order;
5809
- }
5810
- interface BulkMarkOrdersAsPaidRequest {
5648
+ paymentProvider?: string | null;
5811
5649
  /**
5812
- * IDs of orders to mark as paid.
5813
- * @minSize 1
5814
- * @maxSize 100
5815
- * @minLength 1
5816
- * @maxLength 100
5650
+ * Record of chargebacks made by the buyer.
5651
+ * @maxSize 6
5817
5652
  */
5818
- ecomOrderIds: string[];
5819
- }
5820
- interface BulkMarkOrdersAsPaidResponse {
5653
+ chargebacks?: Chargeback[];
5821
5654
  /**
5822
- * Items updated by the bulk action.
5823
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5655
+ * Payment method ID.
5656
+ * @internal
5657
+ * @maxLength 36
5824
5658
  */
5825
- results?: BulkOrderResult[];
5826
- /** Bulk action metadata. */
5827
- bulkActionMetadata?: BulkActionMetadata;
5828
- }
5829
- interface BulkOrderResult {
5830
- /** Item metadata. */
5831
- itemMetadata?: ItemMetadata;
5659
+ paymentMethodId?: string | null;
5660
+ /** Platform fee amount associated with this payment. */
5661
+ platformFee?: Price;
5832
5662
  /**
5833
- * Updated order.
5834
- *
5835
- * Returned when `returnFullEntity = true`.
5663
+ * Payment method with buyer and optional owner translations.
5664
+ * Non-exhaustive list of supported values:
5665
+ * + `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`
5836
5666
  */
5837
- item?: Order;
5838
- }
5839
- interface ItemMetadata {
5840
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5841
- _id?: string | null;
5842
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5843
- originalIndex?: number;
5844
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5845
- success?: boolean;
5846
- /** Details about the error in case of failure. */
5847
- error?: ApplicationError;
5667
+ paymentMethodName?: PaymentMethodName;
5848
5668
  }
5849
- interface ApplicationError {
5850
- /** Error code. */
5851
- code?: string;
5852
- /** Description of the error. */
5853
- description?: string;
5854
- /** Data related to the error. */
5855
- data?: Record<string, any> | null;
5669
+ /** @oneof */
5670
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5671
+ /** Credit card details. */
5672
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5856
5673
  }
5857
- interface BulkActionMetadata {
5858
- /** Number of items that were successfully processed. */
5859
- totalSuccesses?: number;
5860
- /** Number of items that couldn't be processed. */
5861
- totalFailures?: number;
5862
- /** Number of failures without details because detailed failure threshold was exceeded. */
5863
- undetailedFailures?: number;
5674
+ declare enum TransactionStatus {
5675
+ UNDEFINED = "UNDEFINED",
5676
+ APPROVED = "APPROVED",
5677
+ PENDING = "PENDING",
5678
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5679
+ CANCELED = "CANCELED",
5680
+ DECLINED = "DECLINED",
5681
+ REFUNDED = "REFUNDED",
5682
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5683
+ AUTHORIZED = "AUTHORIZED",
5684
+ VOIDED = "VOIDED"
5864
5685
  }
5865
- interface GetRefundabilityStatusRequest {
5686
+ /** @enumType */
5687
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5688
+ interface CreditCardPaymentMethodDetails {
5866
5689
  /**
5867
- * Order ID.
5868
- * @minLength 1
5690
+ * The last 4 digits of the card number.
5691
+ * @maxLength 4
5692
+ */
5693
+ lastFourDigits?: string | null;
5694
+ /**
5695
+ * Card issuer's brand.
5869
5696
  * @maxLength 100
5870
5697
  */
5871
- ecomOrderId: string;
5698
+ brand?: string | null;
5872
5699
  }
5873
- interface GetRefundabilityStatusResponse {
5700
+ interface AuthorizationDetails {
5874
5701
  /**
5875
- * Refundability details.
5876
- * @maxSize 300
5702
+ * Whether the authorized payment is of a delayed capture.
5703
+ * @readonly
5877
5704
  */
5878
- refundabilities?: Refundability[];
5705
+ delayedCapture?: boolean;
5706
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5707
+ authorizedDate?: Date | null;
5879
5708
  /**
5880
- * Whether the order supports refunding per item.
5881
- * @deprecated
5709
+ * List of captures associated with payment
5710
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5711
+ * @maxSize 1
5882
5712
  */
5883
- refundablePerItem?: boolean;
5713
+ captures?: AuthorizationCapture[];
5714
+ /** Void associated with payment */
5715
+ void?: AuthorizationVoid;
5716
+ /** Scheduled action for this transaction */
5717
+ scheduledAction?: V1ScheduledAction;
5884
5718
  }
5885
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5886
- /** Reason why payment is not refundable. */
5887
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5888
- /** Reason why payment is only refundable manually. */
5889
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5890
- /** Payment ID. */
5891
- paymentId?: string;
5892
- /** Payment refundability status. */
5893
- refundabilityStatus?: RefundableStatusWithLiterals;
5894
- /** Link to payment provider dashboard. */
5895
- providerLink?: string | null;
5719
+ interface AuthorizationCapture {
5720
+ /**
5721
+ * Capture ID.
5722
+ * @format GUID
5723
+ * @readonly
5724
+ */
5725
+ _id?: string | null;
5726
+ /** Status of this capture action */
5727
+ status?: AuthorizationCaptureStatusWithLiterals;
5728
+ /**
5729
+ * Amount of this capture
5730
+ * @immutable
5731
+ */
5732
+ amount?: Price;
5733
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5734
+ _createdDate?: Date | null;
5735
+ /** In case of status is FAILED may contain failure details */
5736
+ failureDetails?: AuthorizationActionFailureDetails;
5896
5737
  }
5897
- /** @oneof */
5898
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5899
- /** Reason why payment is not refundable. */
5900
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5901
- /** Reason why payment is only refundable manually. */
5902
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5738
+ declare enum AuthorizationCaptureStatus {
5739
+ /** Capture operation still in progress. */
5740
+ PENDING = "PENDING",
5741
+ /** Capture operation succeeded. */
5742
+ SUCCEEDED = "SUCCEEDED",
5743
+ /** Capture operation failed. */
5744
+ FAILED = "FAILED"
5903
5745
  }
5904
- declare enum RefundableStatus {
5905
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5906
- MANUAL = "MANUAL",
5907
- REFUNDABLE = "REFUNDABLE"
5746
+ /** @enumType */
5747
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5748
+ interface AuthorizationActionFailureDetails {
5749
+ /** @maxLength 100 */
5750
+ failureCode?: string;
5751
+ }
5752
+ interface AuthorizationVoid {
5753
+ /** Status of this void action */
5754
+ status?: AuthorizationVoidStatusWithLiterals;
5755
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5756
+ voidedDate?: Date | null;
5757
+ /** In case of status is FAILED may contain failure details */
5758
+ failureDetails?: AuthorizationActionFailureDetails;
5759
+ /** Reason of void action */
5760
+ reason?: ReasonWithLiterals;
5761
+ }
5762
+ declare enum AuthorizationVoidStatus {
5763
+ /** Void operation still in progress. */
5764
+ PENDING = "PENDING",
5765
+ /** Void operation succeeded. */
5766
+ SUCCEEDED = "SUCCEEDED",
5767
+ /** Void operation failed. */
5768
+ FAILED = "FAILED"
5908
5769
  }
5909
5770
  /** @enumType */
5910
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5911
- declare enum NonRefundableReason {
5912
- NONE = "NONE",
5913
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5914
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5915
- INTERNAL_ERROR = "INTERNAL_ERROR",
5916
- NOT_PAID = "NOT_PAID",
5917
- ACCESS_DENIED = "ACCESS_DENIED",
5918
- ZERO_PRICE = "ZERO_PRICE",
5919
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5920
- PENDING_REFUND = "PENDING_REFUND",
5921
- FORBIDDEN = "FORBIDDEN",
5922
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5923
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5924
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5771
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5772
+ /** Reason the authorization was voided. */
5773
+ declare enum Reason {
5774
+ /** Authorization was voided by user. */
5775
+ MANUAL = "MANUAL",
5776
+ /** Authorization passed execution date. */
5777
+ SCHEDULED = "SCHEDULED"
5925
5778
  }
5926
5779
  /** @enumType */
5927
- 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';
5928
- declare enum ManuallyRefundableReason {
5929
- EXPIRED = "EXPIRED",
5930
- NOT_SUPPORTED = "NOT_SUPPORTED",
5931
- OFFLINE = "OFFLINE",
5932
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5780
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5781
+ interface V1ScheduledAction {
5782
+ /** Type of the action. */
5783
+ actionType?: ActionTypeWithLiterals;
5784
+ /** The date and time of the action. */
5785
+ executionDate?: Date | null;
5786
+ }
5787
+ declare enum ActionType {
5788
+ VOID = "VOID",
5789
+ CAPTURE = "CAPTURE"
5933
5790
  }
5934
5791
  /** @enumType */
5935
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5936
- interface CreatePaymentGatewayOrderRequest {
5792
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5793
+ interface Chargeback {
5937
5794
  /**
5938
- * Ecom order ID.
5939
- * @minLength 1
5940
- * @maxLength 100
5795
+ * Chargeback ID.
5796
+ * @format GUID
5797
+ * @readonly
5798
+ * @immutable
5941
5799
  */
5942
- ecomOrderId: string;
5943
- /** Information about the user who initiated the payment. */
5944
- chargedBy?: ChargedBy;
5800
+ _id?: string;
5945
5801
  /**
5946
- * Whether to delay capture of the payment.
5802
+ * 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.
5803
+ * @readonly
5804
+ * @immutable
5805
+ */
5806
+ _createdDate?: Date | null;
5807
+ /**
5808
+ * 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.
5809
+ * @readonly
5810
+ */
5811
+ _updatedDate?: Date | null;
5812
+ /**
5813
+ * Amount.
5814
+ * @readonly
5815
+ * @immutable
5816
+ */
5817
+ amount?: Price;
5818
+ /**
5819
+ * Reversal amount. Present only when status is REVERSED.
5820
+ * @readonly
5821
+ */
5822
+ reversalAmount?: Price;
5823
+ /**
5824
+ * Status.
5947
5825
  *
5948
- * Default: false
5949
- * @internal
5826
+ * Default: `"APPROVED"`.
5950
5827
  */
5951
- delayedCapture?: boolean;
5952
- }
5953
- interface ChargedBy {
5828
+ status?: ChargebackStatusWithLiterals;
5954
5829
  /**
5955
- * ID - id of the user who initiated the payment
5830
+ * External chargeback ID.
5956
5831
  * @format GUID
5832
+ * @readonly
5833
+ * @immutable
5957
5834
  */
5958
- _id?: string;
5835
+ externalId?: string | null;
5836
+ }
5837
+ declare enum ChargebackStatus {
5838
+ /** Chargeback was approved. */
5839
+ APPROVED = "APPROVED",
5840
+ /** Chargeback was reversed. */
5841
+ REVERSED = "REVERSED"
5842
+ }
5843
+ /** @enumType */
5844
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5845
+ interface PaymentMethodName {
5959
5846
  /**
5960
- * Full name - name of the user who initiated the payment
5961
- * @minLength 1
5962
- * @maxLength 200
5847
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5848
+ * @maxLength 150
5963
5849
  */
5964
- fullName?: string | null;
5965
- }
5966
- interface CreatePaymentGatewayOrderResponse {
5967
- /** ID of the order created in the payment gateway */
5968
- paymentGatewayOrderId?: string;
5850
+ buyerLanguageName?: string | null;
5851
+ /**
5852
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5853
+ *
5854
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5855
+ * @maxLength 150
5856
+ */
5857
+ siteLanguageName?: string | null;
5858
+ /**
5859
+ * User-provided payment method name.
5860
+ *
5861
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5862
+ */
5863
+ userDefinedName?: UserDefinedPaymentMethodName;
5969
5864
  }
5970
- interface ChargeMembershipsRequest {
5865
+ interface GiftCardPaymentDetails {
5971
5866
  /**
5972
- * Order ID.
5973
- * @minLength 1
5867
+ * Gift card payment ID.
5974
5868
  * @maxLength 100
5975
5869
  */
5976
- ecomOrderId: string;
5870
+ giftCardPaymentId?: string;
5977
5871
  /**
5978
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5979
- * but a user which is using the membership on behalf of the a member
5872
+ * Gift card ID.
5873
+ * @internal
5874
+ * @deprecated
5875
+ */
5876
+ giftCardId?: string;
5877
+ /**
5878
+ * ID of the app that created the gift card.
5980
5879
  * @format GUID
5981
5880
  */
5982
- memberId: string;
5881
+ appId?: string;
5882
+ /**
5883
+ * Whether the gift card is voided.
5884
+ * @readonly
5885
+ * @deprecated Whether the gift card is voided.
5886
+ * @replacedBy payment.status
5887
+ * @targetRemovalDate 2026-11-01
5888
+ */
5889
+ voided?: boolean;
5983
5890
  /**
5984
- * List of items to be paid by memberships
5985
- * @minSize 1
5986
- * @maxSize 300
5891
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5892
+ * @maxLength 30
5893
+ * @immutable
5987
5894
  */
5988
- membershipCharges?: MembershipChargeItem[];
5895
+ obfuscatedCode?: string | null;
5989
5896
  }
5990
- interface MembershipChargeItem {
5897
+ interface MembershipPaymentDetails {
5991
5898
  /**
5992
- * The id of used membership
5993
- * @minLength 1
5994
- * @maxLength 100
5899
+ * Membership ID.
5900
+ * @maxLength 200
5995
5901
  */
5996
5902
  membershipId?: string;
5997
5903
  /**
5998
- * ID of the application providing this payment option
5999
- * @format GUID
5904
+ * ID of the line item this membership applies to.
5905
+ * @minLength 1
5906
+ * @maxLength 100
6000
5907
  */
6001
- appId?: string;
6002
- /** The name of used membership */
6003
- membershipName?: MembershipName;
6004
- /** Additional data about this membership */
6005
- membershipAdditionalData?: Record<string, any> | null;
6006
- /** Catalog and item reference info. */
6007
- catalogReference?: CatalogReference;
6008
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
6009
- serviceProperties?: ServiceProperties;
5908
+ lineItemId?: string;
6010
5909
  /**
6011
- * Usually would be the same as catalogReference.catalogItemId
6012
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
6013
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
6014
- * @minLength 1
6015
- * @maxLength 36
5910
+ * Payment status.
5911
+ * @deprecated Payment status.
5912
+ * @replacedBy payment.status
5913
+ * @targetRemovalDate 2026-11-01
6016
5914
  */
6017
- rootCatalogItemId?: string | null;
5915
+ status?: MembershipPaymentStatusWithLiterals;
5916
+ /** Membership name. */
5917
+ name?: MembershipName;
6018
5918
  /**
6019
- * line item id of Checkout/Order line item
5919
+ * The transaction ID in the membership system. Can be used to void the transaction.
6020
5920
  * @minLength 1
6021
5921
  * @maxLength 100
6022
5922
  */
6023
- lineItemId?: string;
6024
- }
6025
- interface MembershipName {
5923
+ externalTransactionId?: string | null;
6026
5924
  /**
6027
- * Membership name in the site's original language.
6028
- * @maxLength 100
5925
+ * Whether the membership is voided.
5926
+ * @readonly
5927
+ * @deprecated Whether the membership is voided.
5928
+ * @replacedBy payment.status
5929
+ * @targetRemovalDate 2026-11-01
6029
5930
  */
6030
- original?: string;
5931
+ voided?: boolean;
6031
5932
  /**
6032
- * Membership name translated into the buyer's language.
6033
- *
6034
- * Default: The value of `original`
6035
- * @maxLength 100
5933
+ * ID of the application providing this payment option.
5934
+ * @format GUID
6036
5935
  */
6037
- translated?: string | null;
5936
+ providerAppId?: string;
5937
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5938
+ futureMembership?: FutureMembershipDetails;
6038
5939
  }
6039
- interface ChargeMembershipsResponse {
5940
+ declare enum MembershipPaymentStatus {
5941
+ /** Payment was charged. */
5942
+ CHARGED = "CHARGED",
5943
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5944
+ CHARGE_FAILED = "CHARGE_FAILED",
5945
+ /** Payment is pending. */
5946
+ CHARGE_PENDING = "CHARGE_PENDING",
5947
+ /** Payment was voided. */
5948
+ VOIDED = "VOIDED"
6040
5949
  }
6041
- interface TriggerRefundRequest {
5950
+ /** @enumType */
5951
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5952
+ interface FutureMembershipDetails {
6042
5953
  /**
6043
- * The order this refund related to
6044
- * @minLength 1
6045
- * @maxLength 100
5954
+ * ID of the plan line item in the order from which the membership will be created.
5955
+ * @format GUID
6046
5956
  */
6047
- ecomOrderId: string;
5957
+ lineItemId?: string;
6048
5958
  /**
6049
- * Refund operations information
6050
- * @minSize 1
6051
- * @maxSize 1
5959
+ * ID of the benefit the future membership will grant.
5960
+ * @maxLength 200
6052
5961
  */
6053
- payments: PaymentRefund[];
6054
- /** Business model of a refund */
6055
- details?: RefundDetails;
6056
- /** Side effect details related to refund */
6057
- sideEffects?: RefundSideEffects;
5962
+ benefitId?: string;
6058
5963
  }
6059
- interface PaymentRefund {
5964
+ interface WixReceiptInfo {
6060
5965
  /**
6061
- * Specific payment within the order to refund
5966
+ * Receipt ID
6062
5967
  * @format GUID
6063
5968
  */
6064
- paymentId?: string;
6065
- /** Refund amount. Not relevant for membership and gift card refunds. */
6066
- amount?: Price;
6067
- /**
6068
- * Whether refund is made externally and manually (on the payment provider's side)
6069
- * 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.
6070
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
6071
- */
6072
- externalRefund?: boolean;
5969
+ receiptId?: string;
6073
5970
  /**
6074
- * Gateway refund id. When param is present, new refund is not created.
6075
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6076
- * and all side effects from request will be executed.
6077
- * @internal
5971
+ * Display number of receipt
6078
5972
  * @minLength 1
6079
- * @maxLength 100
5973
+ * @maxLength 40
6080
5974
  */
6081
- gatewayRefundId?: string | null;
5975
+ displayNumber?: string | null;
6082
5976
  }
6083
- interface RefundSideEffects {
6084
- /** Inventory restock details as part of this refund. */
6085
- restockInfo?: RestockInfo;
6086
- /** Whether to send a refund confirmation email to the customer. */
6087
- sendOrderRefundedEmail?: boolean;
5977
+ interface ExternalReceiptInfo {
6088
5978
  /**
6089
- * Custom message added to the refund confirmation email.
6090
- * @minLength 1
6091
- * @maxLength 1000
5979
+ * External receipt ID
5980
+ * @maxLength 100
6092
5981
  */
6093
- customMessage?: string | null;
6094
- }
6095
- interface RestockInfo {
6096
- /** Restock type. */
6097
- type?: RestockTypeWithLiterals;
5982
+ receiptId?: string | null;
6098
5983
  /**
6099
- * Deprecated, use items instead
6100
- * @internal
6101
- * @maxSize 300
6102
- * @deprecated
5984
+ * ID of the app providing the receipt
5985
+ * @format GUID
6103
5986
  */
6104
- lineItemIds?: string[];
5987
+ appId?: string | null;
6105
5988
  /**
6106
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6107
- * @maxSize 300
5989
+ * Display number of receipt
5990
+ * @minLength 1
5991
+ * @maxLength 40
6108
5992
  */
6109
- items?: RestockItem[];
6110
- }
6111
- declare enum RestockType {
6112
- NO_ITEMS = "NO_ITEMS",
6113
- ALL_ITEMS = "ALL_ITEMS",
6114
- SOME_ITEMS = "SOME_ITEMS"
5993
+ displayNumber?: string | null;
6115
5994
  }
6116
- /** @enumType */
6117
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6118
- interface RestockItem {
5995
+ interface CashRoundingDetails {
6119
5996
  /**
6120
- * ID of the line item being restocked.
6121
- * @format GUID
5997
+ * Payment amount before cash rounding was applied.
5998
+ * When provided, balance and status calculations use this value instead of `amount`
5999
+ * to prevent false overpayment or underpayment due to rounding.
6122
6000
  */
6123
- lineItemId?: string;
6001
+ unroundedAmount?: Price;
6124
6002
  /**
6125
- * Line item quantity being restocked.
6126
- * @min 1
6127
- * @max 100000
6003
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6004
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6005
+ * @readonly
6128
6006
  */
6129
- quantity?: number;
6007
+ roundingAdjustment?: CashRounding;
6008
+ }
6009
+ declare enum PaymentStatus {
6010
+ /** Payment was charged successfully. */
6011
+ APPROVED = "APPROVED",
6012
+ /** Payment is being processed and hasn't been confirmed yet. */
6013
+ PENDING = "PENDING",
6014
+ /** 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. */
6015
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6016
+ /** Payment was canceled before it was charged. */
6017
+ CANCELED = "CANCELED",
6018
+ /** Payment was declined by the payment provider. */
6019
+ DECLINED = "DECLINED",
6020
+ /** Payment was fully refunded. */
6021
+ REFUNDED = "REFUNDED",
6022
+ /** Part of the payment amount was refunded. */
6023
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6024
+ /** 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. */
6025
+ AUTHORIZED = "AUTHORIZED",
6130
6026
  /**
6131
- * Per-location breakdown of restock quantities.
6132
- * @internal
6133
- * @maxSize 5
6027
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6028
+ *
6029
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6134
6030
  */
6135
- restockLocations?: RestockLocation[];
6031
+ VOIDED = "VOIDED"
6136
6032
  }
6137
- interface TriggerRefundResponse {
6138
- /** All order's transactions after the refunds were added */
6139
- orderTransactions?: OrderTransactions;
6140
- /** Created refund ID */
6141
- refundId?: string | null;
6142
- /** Payment ID's that the refund execution had failed for */
6143
- failedPaymentIds?: ItemMetadata[];
6033
+ /** @enumType */
6034
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6035
+ interface CanceledStatusDetails {
6036
+ reason?: CanceledReasonWithLiterals;
6144
6037
  }
6145
- /**
6146
- * A record of all payments and refunds associated with an order.
6147
- *
6148
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6149
- */
6150
- interface OrderTransactions {
6151
- /**
6152
- * Order ID.
6153
- * @format GUID
6154
- */
6155
- orderId?: string;
6156
- /**
6157
- * Record of payments made to the merchant.
6158
- * @maxSize 100
6159
- */
6160
- payments?: Payment[];
6161
- /**
6162
- * Record of refunds made to the buyer.
6163
- * @maxSize 300
6164
- */
6165
- refunds?: Refund[];
6038
+ declare enum CanceledReason {
6039
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6040
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6041
+ /** Payment was not completed by user and expired. */
6042
+ EXPIRED = "EXPIRED"
6043
+ }
6044
+ /** @enumType */
6045
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6046
+ interface DeclinedStatusDetails {
6047
+ reason?: DeclinedReasonWithLiterals;
6048
+ }
6049
+ declare enum DeclinedReason {
6050
+ /** Corresponding charge failed. */
6051
+ CHARGE_FAILED = "CHARGE_FAILED",
6052
+ /** Payment details expired. */
6053
+ EXPIRED = "EXPIRED",
6054
+ /** Insufficient funds. */
6055
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6056
+ /** Gift card was disabled before charge was attempted. */
6057
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6166
6058
  }
6167
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6168
- /** Regular payment details. */
6169
- regularPaymentDetails?: RegularPaymentDetails;
6170
- /** Gift card payment details. */
6171
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6172
- /** Membership payment details. */
6173
- membershipPaymentDetails?: MembershipPaymentDetails;
6174
- /**
6175
- * Receipt created by Wix
6176
- * @internal
6177
- */
6178
- wixReceipt?: WixReceiptInfo;
6059
+ /** @enumType */
6060
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6061
+ interface VoidedStatusDetails {
6062
+ reason?: VoidedReasonWithLiterals;
6063
+ }
6064
+ declare enum VoidedReason {
6065
+ /** Payment was voided by merchant request. */
6066
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6067
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6068
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6069
+ }
6070
+ /** @enumType */
6071
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6072
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6073
+ /** @internal */
6074
+ canceled?: CanceledStatusDetails;
6075
+ /** @internal */
6076
+ declined?: DeclinedStatusDetails;
6077
+ /** @internal */
6078
+ voided?: VoidedStatusDetails;
6179
6079
  /**
6180
- * Receipt created by an external system.
6080
+ * Reason code from the payment gateway.
6181
6081
  * @internal
6082
+ * @minLength 1
6083
+ * @maxLength 10
6182
6084
  */
6183
- externalReceipt?: ExternalReceiptInfo;
6085
+ paymentGatewayReasonCode?: string | null;
6086
+ }
6087
+ /** @oneof */
6088
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6184
6089
  /** @internal */
6185
6090
  canceled?: CanceledStatusDetails;
6186
6091
  /** @internal */
6187
6092
  declined?: DeclinedStatusDetails;
6188
6093
  /** @internal */
6189
6094
  voided?: VoidedStatusDetails;
6095
+ }
6096
+ interface Refund {
6190
6097
  /**
6191
- * Payment ID.
6098
+ * Refund ID.
6192
6099
  * @format GUID
6193
6100
  * @readonly
6194
6101
  */
6195
- _id?: string | null;
6196
- /** 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. */
6197
- _createdDate?: Date | null;
6102
+ _id?: string;
6198
6103
  /**
6199
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6104
+ * List of transactions.
6105
+ * @maxSize 50
6106
+ */
6107
+ transactions?: RefundTransaction[];
6108
+ /** Refund business details. */
6109
+ details?: RefundDetails;
6110
+ /**
6111
+ * 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.
6200
6112
  * @readonly
6113
+ * @immutable
6201
6114
  */
6202
- _updatedDate?: Date | null;
6203
- /** Payment amount. */
6204
- amount?: Price;
6115
+ _createdDate?: Date | null;
6205
6116
  /**
6206
- * Whether refunds for this payment are disabled.
6207
- * + `true`: This payment is not refundable.
6208
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6117
+ * Aggregated refund summary.
6118
+ * @readonly
6209
6119
  */
6210
- refundDisabled?: boolean;
6120
+ summary?: AggregatedRefundSummary;
6211
6121
  /**
6212
- * Whether receipt generation is allowed for this payment.
6213
- * + `true`: This payment supports receipt generation.
6214
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6122
+ * ID of the app that initiated this refund.
6123
+ * @format GUID
6215
6124
  * @readonly
6125
+ * @immutable
6216
6126
  */
6217
- supportReceiptGeneration?: boolean;
6218
- /** Details about cash rounding applied to this payment, when relevant. */
6219
- cashRounding?: CashRoundingDetails;
6127
+ requestingServiceAppId?: string | null;
6128
+ }
6129
+ interface RefundTransaction {
6220
6130
  /**
6221
- * Overall payment status.
6222
- *
6223
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6131
+ * ID of the payment associated with this refund.
6132
+ * @format GUID
6133
+ * @immutable
6224
6134
  */
6225
- status?: PaymentStatusWithLiterals;
6135
+ paymentId?: string;
6226
6136
  /**
6227
- * Detailed payment status information including gateway reason codes and status-specific details.
6228
- * @internal
6137
+ * Refund amount.
6138
+ * @immutable
6229
6139
  */
6230
- paymentStatusDetails?: PaymentStatusDetails;
6140
+ amount?: Price;
6141
+ /** Refund status. */
6142
+ refundStatus?: RefundStatusWithLiterals;
6143
+ /** Optional details of current refund status. */
6144
+ refundStatusInfo?: RefundStatusInfo;
6231
6145
  /**
6232
- * Location where the payment was processed.
6146
+ * Payment gateway's refund ID.
6147
+ * This field is only returned when the value of `external_refund` is `false`.
6148
+ * @format GUID
6149
+ */
6150
+ gatewayRefundId?: string | null;
6151
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6152
+ providerRefundId?: string | null;
6153
+ /**
6154
+ * Whether refund was made externally and manually on the payment provider's side.
6155
+ * @immutable
6156
+ */
6157
+ externalRefund?: boolean;
6158
+ /**
6159
+ * Location where the refund was processed.
6233
6160
  * @internal
6234
6161
  * @format GUID
6235
6162
  * @immutable
6236
6163
  */
6237
6164
  locationId?: string | null;
6165
+ }
6166
+ /** Refund transaction status. */
6167
+ declare enum RefundStatus {
6168
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6169
+ PENDING = "PENDING",
6170
+ /** Refund transaction succeeded. */
6171
+ SUCCEEDED = "SUCCEEDED",
6172
+ /** Refund transaction failed. */
6173
+ FAILED = "FAILED",
6174
+ /** Refund request acknowledged, and will be executed soon. */
6175
+ SCHEDULED = "SCHEDULED",
6176
+ /** Refund was initiated on payment provider side. */
6177
+ STARTED = "STARTED"
6178
+ }
6179
+ /** @enumType */
6180
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6181
+ interface RefundStatusInfo {
6238
6182
  /**
6239
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6183
+ * Reason code for the refund's current status.
6184
+ *
6185
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6186
+ * @minLength 1
6187
+ * @maxLength 10
6188
+ */
6189
+ paymentGatewayReasonCode?: string | null;
6190
+ /**
6191
+ * Free text explanation of current refund status.
6192
+ * @minLength 1
6193
+ * @maxLength 1000
6194
+ */
6195
+ description?: string | null;
6196
+ }
6197
+ interface AggregatedRefundSummary {
6198
+ /** Total amount requested for refund. */
6199
+ requestedRefund?: Price;
6200
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6201
+ pendingRefund?: Price;
6202
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6203
+ refunded?: Price;
6204
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6205
+ failedRefundAmount?: Price;
6206
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6207
+ pending?: boolean;
6208
+ /** Breakdown of refunded items. Available only after refund is complete. */
6209
+ breakdown?: RefundItemsBreakdown;
6210
+ }
6211
+ interface RefundItemsBreakdown {
6212
+ /**
6213
+ * Refunded line items and the amount refunded for each.
6214
+ * @maxSize 300
6215
+ */
6216
+ lineItems?: LineItemRefundSummary[];
6217
+ }
6218
+ interface LineItemRefundSummary {
6219
+ /**
6220
+ * ID of the refunded line item.
6240
6221
  * @format GUID
6241
6222
  */
6242
- chargeCorrelationId?: string | null;
6223
+ lineItemId?: string;
6224
+ /** Total refunded amount for the line item. */
6225
+ totalRefundedAmount?: Price;
6243
6226
  }
6244
- /** @oneof */
6245
- interface PaymentPaymentDetailsOneOf {
6246
- /** Regular payment details. */
6247
- regularPaymentDetails?: RegularPaymentDetails;
6248
- /** Gift card payment details. */
6249
- giftcardPaymentDetails?: GiftCardPaymentDetails;
6250
- /** Membership payment details. */
6251
- membershipPaymentDetails?: MembershipPaymentDetails;
6227
+ interface CalculateRefundRequest {
6228
+ /**
6229
+ * Order ID
6230
+ * @minLength 1
6231
+ * @maxLength 100
6232
+ */
6233
+ ecomOrderId?: string;
6234
+ /**
6235
+ * Refunded line items and quantity
6236
+ * @maxSize 300
6237
+ */
6238
+ refundItems?: CalculateRefundItemRequest[];
6239
+ /** Should include shipping in refund calculation */
6240
+ refundShipping?: boolean;
6252
6241
  }
6253
- /** @oneof */
6254
- interface PaymentReceiptInfoOneOf {
6242
+ interface CalculateRefundItemRequest {
6255
6243
  /**
6256
- * Receipt created by Wix
6257
- * @internal
6244
+ * ID of the line item being refunded
6245
+ * @format GUID
6258
6246
  */
6259
- wixReceipt?: WixReceiptInfo;
6247
+ _id?: string;
6260
6248
  /**
6261
- * Receipt created by an external system.
6262
- * @internal
6249
+ * How much of that line item is being refunded
6250
+ * @min 1
6251
+ * @max 100000
6263
6252
  */
6264
- externalReceipt?: ExternalReceiptInfo;
6253
+ quantity?: number;
6265
6254
  }
6266
- /** @oneof */
6267
- interface PaymentStatusDetailsOneOf {
6268
- /** @internal */
6269
- canceled?: CanceledStatusDetails;
6270
- /** @internal */
6271
- declined?: DeclinedStatusDetails;
6272
- /** @internal */
6273
- voided?: VoidedStatusDetails;
6255
+ interface CalculateRefundResponse {
6256
+ /** Total refundable amount */
6257
+ total?: Price;
6258
+ /** Tax cost of the order */
6259
+ tax?: Price;
6260
+ /** Discount given for this order */
6261
+ discount?: Price;
6262
+ /** Total cost of the order (without tax) */
6263
+ subtotal?: Price;
6264
+ /** Total shipping cost for order */
6265
+ shipping?: Price;
6266
+ /** Previous refund given on that order */
6267
+ previouslyRefundedAmount?: Price;
6268
+ /**
6269
+ * The refundable items of that order
6270
+ * @maxSize 300
6271
+ */
6272
+ items?: CalculateRefundItemResponse[];
6274
6273
  }
6275
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6276
- /** Credit card details. */
6277
- creditCardDetails?: CreditCardPaymentMethodDetails;
6274
+ interface CalculateRefundItemResponse {
6278
6275
  /**
6279
- * Wix Payments order ID.
6280
- * @maxLength 100
6276
+ * Line item ID
6277
+ * @format GUID
6281
6278
  */
6282
- paymentOrderId?: string | null;
6279
+ _id?: string;
6280
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6281
+ price?: Price;
6282
+ }
6283
+ interface VoidAuthorizedPaymentsRequest {
6283
6284
  /**
6284
- * Payment gateway's transaction ID.
6285
- * This field is only returned when the value of `offline_payment` is `false`.
6285
+ * Wix eCommerce order ID
6286
+ * @minLength 1
6286
6287
  * @maxLength 100
6287
6288
  */
6288
- gatewayTransactionId?: string | null;
6289
+ ecomOrderId: string;
6289
6290
  /**
6290
- * Payment method.
6291
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6292
- * Non-exhaustive list of supported values:
6293
- * + `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`
6294
- * @maxLength 150
6295
- * @deprecated Payment method.
6296
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6297
- * Non-exhaustive list of supported values:
6298
- * + `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`
6299
- * @replacedBy payment_method_name
6300
- * @targetRemovalDate 2026-07-01
6291
+ * Payment IDs
6292
+ * @minSize 1
6293
+ * @maxSize 100
6294
+ * @format GUID
6301
6295
  */
6302
- paymentMethod?: string | null;
6296
+ paymentIds: string[];
6297
+ }
6298
+ interface VoidAuthorizedPaymentsResponse {
6299
+ /** All order's transactions after the void was triggered */
6300
+ orderTransactions?: OrderTransactions;
6301
+ }
6302
+ interface CaptureAuthorizedPaymentsRequest {
6303
6303
  /**
6304
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6304
+ * Wix eCommerce order ID
6305
+ * @minLength 1
6305
6306
  * @maxLength 100
6306
6307
  */
6307
- providerTransactionId?: string | null;
6308
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6309
- offlinePayment?: boolean;
6310
- /**
6311
- * Payment status.
6312
- * @deprecated Payment status.
6313
- * @replacedBy payment.status
6314
- * @targetRemovalDate 2026-11-01
6315
- */
6316
- status?: TransactionStatusWithLiterals;
6317
- /** Whether there is a payment agreement that allows for future charges. */
6318
- savedPaymentMethod?: boolean;
6319
- /** Authorization details. */
6320
- authorizationDetails?: AuthorizationDetails;
6308
+ ecomOrderId: string;
6321
6309
  /**
6322
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6323
- * @internal
6324
- * @maxLength 300
6310
+ * Capture payments information
6311
+ * @minSize 1
6312
+ * @maxSize 100
6325
6313
  */
6326
- paymentProvider?: string | null;
6314
+ payments: PaymentCapture[];
6315
+ }
6316
+ interface PaymentCapture {
6327
6317
  /**
6328
- * Record of chargebacks made by the buyer.
6329
- * @maxSize 6
6318
+ * Payment ID
6319
+ * @format GUID
6330
6320
  */
6331
- chargebacks?: Chargeback[];
6321
+ paymentId?: string | null;
6332
6322
  /**
6333
- * Payment method ID.
6334
- * @internal
6335
- * @maxLength 36
6323
+ * Capture amount.
6324
+ * If not provided - full authorized amount will be captured.
6336
6325
  */
6337
- paymentMethodId?: string | null;
6338
- /** Platform fee amount associated with this payment. */
6339
- platformFee?: Price;
6326
+ amount?: Price;
6327
+ }
6328
+ interface CaptureAuthorizedPaymentsResponse {
6329
+ /** All order's transactions after the capture was triggered */
6330
+ orderTransactions?: OrderTransactions;
6331
+ }
6332
+ interface ChargeSavedPaymentMethodRequest {
6340
6333
  /**
6341
- * Payment method with buyer and optional owner translations.
6342
- * Non-exhaustive list of supported values:
6343
- * + `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`
6334
+ * Ecom Order ID.
6335
+ * @minLength 1
6336
+ * @maxLength 100
6344
6337
  */
6345
- paymentMethodName?: PaymentMethodName;
6338
+ ecomOrderId?: string;
6339
+ /** Amount to be charged */
6340
+ amount?: Price;
6346
6341
  }
6347
- /** @oneof */
6348
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6349
- /** Credit card details. */
6350
- creditCardDetails?: CreditCardPaymentMethodDetails;
6342
+ interface ChargeSavedPaymentMethodResponse {
6343
+ /** Payment gateway's order ID (e.g Wix Payments) */
6344
+ paymentGatewayOrderId?: string;
6351
6345
  }
6352
- declare enum TransactionStatus {
6353
- UNDEFINED = "UNDEFINED",
6354
- APPROVED = "APPROVED",
6355
- PENDING = "PENDING",
6356
- PENDING_MERCHANT = "PENDING_MERCHANT",
6357
- CANCELED = "CANCELED",
6358
- DECLINED = "DECLINED",
6359
- REFUNDED = "REFUNDED",
6360
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6361
- AUTHORIZED = "AUTHORIZED",
6362
- VOIDED = "VOIDED"
6346
+ interface SendBuyerConfirmationEmailRequest {
6347
+ /** @format GUID */
6348
+ orderId?: string;
6363
6349
  }
6364
- /** @enumType */
6365
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6366
- interface CreditCardPaymentMethodDetails {
6367
- /**
6368
- * The last 4 digits of the card number.
6369
- * @maxLength 4
6370
- */
6371
- lastFourDigits?: string | null;
6350
+ interface SendBuyerConfirmationEmailResponse {
6351
+ }
6352
+ interface SendBuyerPaymentsReceivedEmailRequest {
6372
6353
  /**
6373
- * Card issuer's brand.
6354
+ * @minLength 1
6374
6355
  * @maxLength 100
6375
6356
  */
6376
- brand?: string | null;
6357
+ orderId?: string;
6377
6358
  }
6378
- interface AuthorizationDetails {
6379
- /**
6380
- * Whether the authorized payment is of a delayed capture.
6381
- * @readonly
6382
- */
6383
- delayedCapture?: boolean;
6384
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6385
- authorizedDate?: Date | null;
6386
- /**
6387
- * List of captures associated with payment
6388
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6389
- * @maxSize 1
6390
- */
6391
- captures?: AuthorizationCapture[];
6392
- /** Void associated with payment */
6393
- void?: AuthorizationVoid;
6394
- /** Scheduled action for this transaction */
6395
- scheduledAction?: V1ScheduledAction;
6359
+ interface SendBuyerPaymentsReceivedEmailResponse {
6396
6360
  }
6397
- interface AuthorizationCapture {
6361
+ interface SendBuyerPickupConfirmationEmailRequest {
6398
6362
  /**
6399
- * Capture ID.
6400
- * @format GUID
6401
- * @readonly
6363
+ * @minLength 1
6364
+ * @maxLength 100
6402
6365
  */
6403
- _id?: string | null;
6404
- /** Status of this capture action */
6405
- status?: AuthorizationCaptureStatusWithLiterals;
6366
+ orderId?: string;
6367
+ }
6368
+ interface SendBuyerPickupConfirmationEmailResponse {
6369
+ }
6370
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
6406
6371
  /**
6407
- * Amount of this capture
6408
- * @immutable
6372
+ * IDs of orders to send pickup emails for.
6373
+ * @minSize 1
6374
+ * @maxSize 300
6409
6375
  */
6410
- amount?: Price;
6411
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6412
- _createdDate?: Date | null;
6413
- /** In case of status is FAILED may contain failure details */
6414
- failureDetails?: AuthorizationActionFailureDetails;
6376
+ orderIds?: string[];
6415
6377
  }
6416
- declare enum AuthorizationCaptureStatus {
6417
- /** Capture operation still in progress. */
6418
- PENDING = "PENDING",
6419
- /** Capture operation succeeded. */
6420
- SUCCEEDED = "SUCCEEDED",
6421
- /** Capture operation failed. */
6422
- FAILED = "FAILED"
6378
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
6423
6379
  }
6424
- /** @enumType */
6425
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6426
- interface AuthorizationActionFailureDetails {
6427
- /** @maxLength 100 */
6428
- failureCode?: string;
6380
+ interface SendBuyerShippingConfirmationEmailRequest {
6381
+ /**
6382
+ * @minLength 1
6383
+ * @maxLength 100
6384
+ */
6385
+ orderId?: string;
6429
6386
  }
6430
- interface AuthorizationVoid {
6431
- /** Status of this void action */
6432
- status?: AuthorizationVoidStatusWithLiterals;
6433
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6434
- voidedDate?: Date | null;
6435
- /** In case of status is FAILED may contain failure details */
6436
- failureDetails?: AuthorizationActionFailureDetails;
6437
- /** Reason of void action */
6438
- reason?: ReasonWithLiterals;
6387
+ interface SendBuyerShippingConfirmationEmailResponse {
6439
6388
  }
6440
- declare enum AuthorizationVoidStatus {
6441
- /** Void operation still in progress. */
6442
- PENDING = "PENDING",
6443
- /** Void operation succeeded. */
6444
- SUCCEEDED = "SUCCEEDED",
6445
- /** Void operation failed. */
6446
- FAILED = "FAILED"
6389
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
6390
+ /**
6391
+ * IDs of orders to send pickup emails for.
6392
+ * @minSize 1
6393
+ * @maxSize 300
6394
+ */
6395
+ orderIds?: string[];
6447
6396
  }
6448
- /** @enumType */
6449
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6450
- /** Reason the authorization was voided. */
6451
- declare enum Reason {
6452
- /** Authorization was voided by user. */
6453
- MANUAL = "MANUAL",
6454
- /** Authorization passed execution date. */
6455
- SCHEDULED = "SCHEDULED"
6397
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
6456
6398
  }
6457
- /** @enumType */
6458
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6459
- interface V1ScheduledAction {
6460
- /** Type of the action. */
6461
- actionType?: ActionTypeWithLiterals;
6462
- /** The date and time of the action. */
6463
- executionDate?: Date | null;
6399
+ interface SendMerchantOrderReceivedNotificationRequest {
6400
+ /**
6401
+ * @minLength 1
6402
+ * @maxLength 100
6403
+ */
6404
+ orderId?: string;
6464
6405
  }
6465
- declare enum ActionType {
6466
- VOID = "VOID",
6467
- CAPTURE = "CAPTURE"
6406
+ interface SendMerchantOrderReceivedNotificationResponse {
6468
6407
  }
6469
- /** @enumType */
6470
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6471
- interface Chargeback {
6408
+ interface SendCancelRefundEmailRequest {
6472
6409
  /**
6473
- * Chargeback ID.
6474
- * @format GUID
6475
- * @readonly
6476
- * @immutable
6410
+ * The ID of order that is canceled/refunded
6411
+ * @minLength 1
6412
+ * @maxLength 100
6477
6413
  */
6478
- _id?: string;
6414
+ orderId?: string;
6479
6415
  /**
6480
- * 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.
6481
- * @readonly
6482
- * @immutable
6416
+ * Personal note added to the email (optional)
6417
+ * @minLength 1
6418
+ * @maxLength 1000
6483
6419
  */
6484
- _createdDate?: Date | null;
6420
+ customMessage?: string | null;
6421
+ /** Refund amount */
6422
+ refundAmount?: Price;
6485
6423
  /**
6486
- * 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.
6487
- * @readonly
6424
+ * Refund ID. (Optional)
6425
+ * @format GUID
6488
6426
  */
6489
- _updatedDate?: Date | null;
6427
+ refundId?: string | null;
6428
+ }
6429
+ interface SendCancelRefundEmailResponse {
6430
+ }
6431
+ interface SendRefundEmailRequest {
6490
6432
  /**
6491
- * Amount.
6492
- * @readonly
6493
- * @immutable
6433
+ * The ID of order that is refunded
6434
+ * @format GUID
6494
6435
  */
6495
- amount?: Price;
6436
+ orderId?: string;
6496
6437
  /**
6497
- * Reversal amount. Present only when status is REVERSED.
6498
- * @readonly
6438
+ * Refund ID
6439
+ * @format GUID
6499
6440
  */
6500
- reversalAmount?: Price;
6441
+ refundId?: string;
6501
6442
  /**
6502
- * Status.
6503
- *
6504
- * Default: `"APPROVED"`.
6443
+ * Personal note added to the email (optional)
6444
+ * @minLength 1
6445
+ * @maxLength 1000
6505
6446
  */
6506
- status?: ChargebackStatusWithLiterals;
6447
+ customMessage?: string | null;
6448
+ }
6449
+ interface SendRefundEmailResponse {
6450
+ }
6451
+ interface SendFulfillmentEmailRequest {
6452
+ /** @format GUID */
6453
+ orderId?: string;
6454
+ /** @format GUID */
6455
+ fulfillerId?: string;
6456
+ }
6457
+ interface SendFulfillmentEmailResponse {
6458
+ }
6459
+ interface SendMerchantOrderReceivedPushRequest {
6507
6460
  /**
6508
- * External chargeback ID.
6509
- * @format GUID
6510
- * @readonly
6511
- * @immutable
6461
+ * @minLength 1
6462
+ * @maxLength 100
6512
6463
  */
6513
- externalId?: string | null;
6464
+ orderId?: string;
6514
6465
  }
6515
- declare enum ChargebackStatus {
6516
- /** Chargeback was approved. */
6517
- APPROVED = "APPROVED",
6518
- /** Chargeback was reversed. */
6519
- REVERSED = "REVERSED"
6466
+ interface SendMerchantOrderReceivedPushResponse {
6467
+ }
6468
+ interface PreviewEmailByTypeRequest {
6469
+ emailType?: PreviewEmailTypeWithLiterals;
6470
+ }
6471
+ declare enum PreviewEmailType {
6472
+ ORDER_PLACED = "ORDER_PLACED",
6473
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6474
+ ORDER_SHIPPED = "ORDER_SHIPPED",
6475
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6520
6476
  }
6521
6477
  /** @enumType */
6522
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6523
- interface PaymentMethodName {
6478
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6479
+ interface PreviewEmailByTypeResponse {
6480
+ emailPreview?: string;
6481
+ }
6482
+ interface PreviewRefundEmailRequest {
6524
6483
  /**
6525
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6526
- * @maxLength 150
6484
+ * @minLength 1
6485
+ * @maxLength 100
6527
6486
  */
6528
- buyerLanguageName?: string | null;
6487
+ orderId?: string;
6488
+ /** Refund amount */
6489
+ refundAmount?: Price;
6490
+ /** Refund business details */
6491
+ details?: RefundDetails;
6529
6492
  /**
6530
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6531
- *
6532
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6533
- * @maxLength 150
6493
+ * Personal note added to the email (optional)
6494
+ * @minLength 1
6495
+ * @maxLength 1000
6534
6496
  */
6535
- siteLanguageName?: string | null;
6497
+ customMessage?: string | null;
6536
6498
  /**
6537
- * User-provided payment method name.
6538
- *
6539
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6499
+ * Refund ID. (Optional)
6500
+ * @format GUID
6540
6501
  */
6541
- userDefinedName?: UserDefinedPaymentMethodName;
6502
+ refundId?: string | null;
6542
6503
  }
6543
- interface GiftCardPaymentDetails {
6504
+ interface PreviewRefundEmailResponse {
6505
+ emailPreview?: string;
6506
+ }
6507
+ interface PreviewCancelEmailRequest {
6544
6508
  /**
6545
- * Gift card payment ID.
6509
+ * @minLength 1
6546
6510
  * @maxLength 100
6547
6511
  */
6548
- giftCardPaymentId?: string;
6512
+ orderId?: string;
6549
6513
  /**
6550
- * Gift card ID.
6551
- * @internal
6552
- * @deprecated
6514
+ * Personal note added to the email (optional)
6515
+ * @minLength 1
6516
+ * @maxLength 1000
6553
6517
  */
6554
- giftCardId?: string;
6518
+ customMessage?: string | null;
6519
+ }
6520
+ interface PreviewCancelEmailResponse {
6521
+ emailPreview?: string;
6522
+ }
6523
+ interface PreviewCancelRefundEmailRequest {
6555
6524
  /**
6556
- * ID of the app that created the gift card.
6557
- * @format GUID
6525
+ * @minLength 1
6526
+ * @maxLength 100
6558
6527
  */
6559
- appId?: string;
6528
+ orderId?: string;
6560
6529
  /**
6561
- * Whether the gift card is voided.
6562
- * @readonly
6563
- * @deprecated Whether the gift card is voided.
6564
- * @replacedBy payment.status
6565
- * @targetRemovalDate 2026-11-01
6530
+ * Personal note added to the email (optional)
6531
+ * @minLength 1
6532
+ * @maxLength 1000
6566
6533
  */
6567
- voided?: boolean;
6534
+ customMessage?: string | null;
6535
+ /** Refund amount */
6536
+ refundAmount?: Price;
6568
6537
  /**
6569
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6570
- * @maxLength 30
6571
- * @immutable
6538
+ * Refund ID. (Optional)
6539
+ * @format GUID
6572
6540
  */
6573
- obfuscatedCode?: string | null;
6541
+ refundId?: string | null;
6574
6542
  }
6575
- interface MembershipPaymentDetails {
6543
+ interface PreviewCancelRefundEmailResponse {
6544
+ emailPreview?: string;
6545
+ }
6546
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
6547
+ }
6548
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
6549
+ emailPreview?: string;
6550
+ }
6551
+ interface PreviewBuyerConfirmationEmailRequest {
6552
+ }
6553
+ interface PreviewBuyerConfirmationEmailResponse {
6554
+ emailPreview?: string;
6555
+ }
6556
+ interface PreviewBuyerPickupConfirmationEmailRequest {
6557
+ }
6558
+ interface PreviewBuyerPickupConfirmationEmailResponse {
6559
+ emailPreview?: string;
6560
+ }
6561
+ interface PreviewShippingConfirmationEmailRequest {
6562
+ }
6563
+ interface PreviewShippingConfirmationEmailResponse {
6564
+ emailPreview?: string;
6565
+ }
6566
+ interface PreviewResendDownloadLinksEmailRequest {
6567
+ }
6568
+ interface PreviewResendDownloadLinksEmailResponse {
6569
+ emailPreview?: string;
6570
+ }
6571
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6572
+ /** Emitted on a meta site creation. */
6573
+ siteCreated?: SiteCreated;
6574
+ /** Emitted on a meta site transfer completion. */
6575
+ siteTransferred?: SiteTransferred;
6576
+ /** Emitted on a meta site deletion. */
6577
+ siteDeleted?: SiteDeleted;
6578
+ /** Emitted on a meta site restoration. */
6579
+ siteUndeleted?: SiteUndeleted;
6580
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6581
+ sitePublished?: SitePublished;
6582
+ /** Emitted on a meta site unpublish. */
6583
+ siteUnpublished?: SiteUnpublished;
6584
+ /** Emitted when meta site is marked as template. */
6585
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6586
+ /** Emitted when meta site is marked as a WixSite. */
6587
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6588
+ /** Emitted when an application is provisioned (installed). */
6589
+ serviceProvisioned?: ServiceProvisioned;
6590
+ /** Emitted when an application is removed (uninstalled). */
6591
+ serviceRemoved?: ServiceRemoved;
6592
+ /** Emitted when meta site name (URL slug) is changed. */
6593
+ siteRenamedPayload?: SiteRenamed;
6594
+ /** Emitted when meta site was permanently deleted. */
6595
+ hardDeleted?: SiteHardDeleted;
6596
+ /** Emitted on a namespace change. */
6597
+ namespaceChanged?: NamespaceChanged;
6598
+ /** Emitted when Studio is attached. */
6599
+ studioAssigned?: StudioAssigned;
6600
+ /** Emitted when Studio is detached. */
6601
+ studioUnassigned?: StudioUnassigned;
6576
6602
  /**
6577
- * Membership ID.
6578
- * @maxLength 200
6603
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6604
+ * the actual URL.
6605
+ *
6606
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6607
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6579
6608
  */
6580
- membershipId?: string;
6609
+ urlChanged?: SiteUrlChanged;
6610
+ /** Site is marked as PurgedExternally */
6611
+ sitePurgedExternally?: SitePurgedExternally;
6612
+ /** Emitted when Odeditor is attached. */
6613
+ odeditorAssigned?: OdeditorAssigned;
6614
+ /** Emitted when Odeditor is detached. */
6615
+ odeditorUnassigned?: OdeditorUnassigned;
6616
+ /** Emitted when Picasso is attached. */
6617
+ picassoAssigned?: PicassoAssigned;
6618
+ /** Emitted when Picasso is detached. */
6619
+ picassoUnassigned?: PicassoUnassigned;
6620
+ /** Emitted when Wixel is attached. */
6621
+ wixelAssigned?: WixelAssigned;
6622
+ /** Emitted when Wixel is detached. */
6623
+ wixelUnassigned?: WixelUnassigned;
6624
+ /** Emitted when StudioTwo is attached. */
6625
+ studioTwoAssigned?: StudioTwoAssigned;
6626
+ /** Emitted when StudioTwo is detached. */
6627
+ studioTwoUnassigned?: StudioTwoUnassigned;
6628
+ /** Emitted when media from user domain is enabled. */
6629
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6630
+ /** Emitted when media from user domain is disabled. */
6631
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6632
+ /** Emitted when Editorless is attached. */
6633
+ editorlessAssigned?: EditorlessAssigned;
6634
+ /** Emitted when Editorless is detached. */
6635
+ editorlessUnassigned?: EditorlessUnassigned;
6581
6636
  /**
6582
- * ID of the line item this membership applies to.
6583
- * @minLength 1
6584
- * @maxLength 100
6637
+ * A meta site id.
6638
+ * @format GUID
6585
6639
  */
6586
- lineItemId?: string;
6640
+ metaSiteId?: string;
6641
+ /** A meta site version. Monotonically increasing. */
6642
+ version?: string;
6643
+ /** A timestamp of the event. */
6644
+ timestamp?: string;
6587
6645
  /**
6588
- * Payment status.
6589
- * @deprecated Payment status.
6590
- * @replacedBy payment.status
6591
- * @targetRemovalDate 2026-11-01
6646
+ * TODO(meta-site): Change validation once validations are disabled for consumers
6647
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6648
+ * @maxSize 4000
6592
6649
  */
6593
- status?: MembershipPaymentStatusWithLiterals;
6594
- /** Membership name. */
6595
- name?: MembershipName;
6650
+ assets?: Asset[];
6651
+ }
6652
+ /** @oneof */
6653
+ interface MetaSiteSpecialEventPayloadOneOf {
6654
+ /** Emitted on a meta site creation. */
6655
+ siteCreated?: SiteCreated;
6656
+ /** Emitted on a meta site transfer completion. */
6657
+ siteTransferred?: SiteTransferred;
6658
+ /** Emitted on a meta site deletion. */
6659
+ siteDeleted?: SiteDeleted;
6660
+ /** Emitted on a meta site restoration. */
6661
+ siteUndeleted?: SiteUndeleted;
6662
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6663
+ sitePublished?: SitePublished;
6664
+ /** Emitted on a meta site unpublish. */
6665
+ siteUnpublished?: SiteUnpublished;
6666
+ /** Emitted when meta site is marked as template. */
6667
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6668
+ /** Emitted when meta site is marked as a WixSite. */
6669
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6670
+ /** Emitted when an application is provisioned (installed). */
6671
+ serviceProvisioned?: ServiceProvisioned;
6672
+ /** Emitted when an application is removed (uninstalled). */
6673
+ serviceRemoved?: ServiceRemoved;
6674
+ /** Emitted when meta site name (URL slug) is changed. */
6675
+ siteRenamedPayload?: SiteRenamed;
6676
+ /** Emitted when meta site was permanently deleted. */
6677
+ hardDeleted?: SiteHardDeleted;
6678
+ /** Emitted on a namespace change. */
6679
+ namespaceChanged?: NamespaceChanged;
6680
+ /** Emitted when Studio is attached. */
6681
+ studioAssigned?: StudioAssigned;
6682
+ /** Emitted when Studio is detached. */
6683
+ studioUnassigned?: StudioUnassigned;
6596
6684
  /**
6597
- * The transaction ID in the membership system. Can be used to void the transaction.
6598
- * @minLength 1
6599
- * @maxLength 100
6685
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6686
+ * the actual URL.
6687
+ *
6688
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6689
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6600
6690
  */
6601
- externalTransactionId?: string | null;
6691
+ urlChanged?: SiteUrlChanged;
6692
+ /** Site is marked as PurgedExternally */
6693
+ sitePurgedExternally?: SitePurgedExternally;
6694
+ /** Emitted when Odeditor is attached. */
6695
+ odeditorAssigned?: OdeditorAssigned;
6696
+ /** Emitted when Odeditor is detached. */
6697
+ odeditorUnassigned?: OdeditorUnassigned;
6698
+ /** Emitted when Picasso is attached. */
6699
+ picassoAssigned?: PicassoAssigned;
6700
+ /** Emitted when Picasso is detached. */
6701
+ picassoUnassigned?: PicassoUnassigned;
6702
+ /** Emitted when Wixel is attached. */
6703
+ wixelAssigned?: WixelAssigned;
6704
+ /** Emitted when Wixel is detached. */
6705
+ wixelUnassigned?: WixelUnassigned;
6706
+ /** Emitted when StudioTwo is attached. */
6707
+ studioTwoAssigned?: StudioTwoAssigned;
6708
+ /** Emitted when StudioTwo is detached. */
6709
+ studioTwoUnassigned?: StudioTwoUnassigned;
6710
+ /** Emitted when media from user domain is enabled. */
6711
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
6712
+ /** Emitted when media from user domain is disabled. */
6713
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
6714
+ /** Emitted when Editorless is attached. */
6715
+ editorlessAssigned?: EditorlessAssigned;
6716
+ /** Emitted when Editorless is detached. */
6717
+ editorlessUnassigned?: EditorlessUnassigned;
6718
+ }
6719
+ interface Asset {
6602
6720
  /**
6603
- * Whether the membership is voided.
6604
- * @readonly
6605
- * @deprecated Whether the membership is voided.
6606
- * @replacedBy payment.status
6607
- * @targetRemovalDate 2026-11-01
6721
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6722
+ * @maxLength 36
6608
6723
  */
6609
- voided?: boolean;
6724
+ appDefId?: string;
6610
6725
  /**
6611
- * ID of the application providing this payment option.
6612
- * @format GUID
6726
+ * An instance id. For legacy reasons may be UUID or a string.
6727
+ * @maxLength 200
6613
6728
  */
6614
- providerAppId?: string;
6615
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6616
- futureMembership?: FutureMembershipDetails;
6729
+ instanceId?: string;
6730
+ /** An application state. */
6731
+ state?: StateWithLiterals;
6617
6732
  }
6618
- declare enum MembershipPaymentStatus {
6619
- /** Payment was charged. */
6620
- CHARGED = "CHARGED",
6621
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
6622
- CHARGE_FAILED = "CHARGE_FAILED",
6623
- /** Payment is pending. */
6624
- CHARGE_PENDING = "CHARGE_PENDING",
6625
- /** Payment was voided. */
6626
- VOIDED = "VOIDED"
6733
+ declare enum State {
6734
+ UNKNOWN = "UNKNOWN",
6735
+ ENABLED = "ENABLED",
6736
+ DISABLED = "DISABLED",
6737
+ PENDING = "PENDING",
6738
+ DEMO = "DEMO"
6627
6739
  }
6628
6740
  /** @enumType */
6629
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6630
- interface FutureMembershipDetails {
6741
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6742
+ interface SiteCreated {
6631
6743
  /**
6632
- * ID of the plan line item in the order from which the membership will be created.
6633
- * @format GUID
6744
+ * A template identifier (empty if not created from a template).
6745
+ * @maxLength 36
6634
6746
  */
6635
- lineItemId?: string;
6747
+ originTemplateId?: string;
6636
6748
  /**
6637
- * ID of the benefit the future membership will grant.
6638
- * @maxLength 200
6749
+ * An account id of the owner.
6750
+ * @format GUID
6639
6751
  */
6640
- benefitId?: string;
6641
- }
6642
- interface WixReceiptInfo {
6752
+ ownerId?: string;
6753
+ /** A context in which meta site was created. */
6754
+ context?: SiteCreatedContextWithLiterals;
6643
6755
  /**
6644
- * Receipt ID
6756
+ * A meta site id from which this site was created.
6757
+ *
6758
+ * In case of a creation from a template it's a template id.
6759
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6645
6760
  * @format GUID
6646
6761
  */
6647
- receiptId?: string;
6762
+ originMetaSiteId?: string | null;
6648
6763
  /**
6649
- * Display number of receipt
6650
- * @minLength 1
6651
- * @maxLength 40
6764
+ * A meta site name (URL slug).
6765
+ * @maxLength 20
6652
6766
  */
6653
- displayNumber?: string | null;
6767
+ siteName?: string;
6768
+ /** A namespace. */
6769
+ namespace?: NamespaceWithLiterals;
6654
6770
  }
6655
- interface ExternalReceiptInfo {
6656
- /**
6657
- * External receipt ID
6658
- * @maxLength 100
6659
- */
6660
- receiptId?: string | null;
6771
+ declare enum SiteCreatedContext {
6772
+ /** A valid option, we don't expose all reasons why site might be created. */
6773
+ OTHER = "OTHER",
6774
+ /** A meta site was created from template. */
6775
+ FROM_TEMPLATE = "FROM_TEMPLATE",
6776
+ /** A meta site was created by copying of the transfferred meta site. */
6777
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6778
+ /** A copy of existing meta site. */
6779
+ DUPLICATE = "DUPLICATE",
6780
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6781
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6782
+ /** deprecated A meta site was created for Flash editor. */
6783
+ FLASH = "FLASH"
6784
+ }
6785
+ /** @enumType */
6786
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6787
+ declare enum Namespace {
6788
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6789
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6790
+ WIX = "WIX",
6791
+ /** 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. */
6792
+ SHOUT_OUT = "SHOUT_OUT",
6793
+ /** 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. */
6794
+ ALBUMS = "ALBUMS",
6795
+ /** 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. */
6796
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6797
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6798
+ HOTELS = "HOTELS",
6799
+ /** 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. */
6800
+ CLUBS = "CLUBS",
6801
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6802
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6661
6803
  /**
6662
- * ID of the app providing the receipt
6663
- * @format GUID
6804
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6805
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6664
6806
  */
6665
- appId?: string | null;
6807
+ DEV_SITE = "DEV_SITE",
6808
+ /** 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. */
6809
+ LOGOS = "LOGOS",
6810
+ /** 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. */
6811
+ VIDEO_MAKER = "VIDEO_MAKER",
6812
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6813
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6814
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6815
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6666
6816
  /**
6667
- * Display number of receipt
6668
- * @minLength 1
6669
- * @maxLength 40
6817
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6818
+ *
6819
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
6670
6820
  */
6671
- displayNumber?: string | null;
6672
- }
6673
- interface CashRoundingDetails {
6821
+ HTML_DRAFT = "HTML_DRAFT",
6674
6822
  /**
6675
- * Payment amount before cash rounding was applied.
6676
- * When provided, balance and status calculations use this value instead of `amount`
6677
- * to prevent false overpayment or underpayment due to rounding.
6823
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6824
+ * Will be accessible from Site List and will not have a website app.
6825
+ * Once the user attaches a site, the site will become a regular wixsite.
6678
6826
  */
6679
- unroundedAmount?: Price;
6827
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
6828
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6829
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
6830
+ /** It is to be used in the Business First efforts. */
6831
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
6832
+ /** Bookings business flow with no site. */
6833
+ ANYWHERE = "ANYWHERE",
6834
+ /** Namespace for Headless Backoffice with no editor */
6835
+ HEADLESS = "HEADLESS",
6680
6836
  /**
6681
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6682
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6683
- * @readonly
6837
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6838
+ * The site will be used for account level CSM feature for enterprise
6684
6839
  */
6685
- roundingAdjustment?: CashRounding;
6686
- }
6687
- declare enum PaymentStatus {
6688
- /** Payment was charged successfully. */
6689
- APPROVED = "APPROVED",
6690
- /** Payment is being processed and hasn't been confirmed yet. */
6691
- PENDING = "PENDING",
6692
- /** 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. */
6693
- PENDING_MERCHANT = "PENDING_MERCHANT",
6694
- /** Payment was canceled before it was charged. */
6695
- CANCELED = "CANCELED",
6696
- /** Payment was declined by the payment provider. */
6697
- DECLINED = "DECLINED",
6698
- /** Payment was fully refunded. */
6699
- REFUNDED = "REFUNDED",
6700
- /** Part of the payment amount was refunded. */
6701
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6702
- /** 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. */
6703
- AUTHORIZED = "AUTHORIZED",
6840
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6841
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6842
+ RISE = "RISE",
6704
6843
  /**
6705
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6706
- *
6707
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6844
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6845
+ * There's a blank site behind the scene but it's blank).
6846
+ * The Mobile company will be the owner of this namespace.
6708
6847
  */
6709
- VOIDED = "VOIDED"
6710
- }
6711
- /** @enumType */
6712
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6713
- interface CanceledStatusDetails {
6714
- reason?: CanceledReasonWithLiterals;
6715
- }
6716
- declare enum CanceledReason {
6717
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
6718
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6719
- /** Payment was not completed by user and expired. */
6720
- EXPIRED = "EXPIRED"
6721
- }
6722
- /** @enumType */
6723
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6724
- interface DeclinedStatusDetails {
6725
- reason?: DeclinedReasonWithLiterals;
6726
- }
6727
- declare enum DeclinedReason {
6728
- /** Corresponding charge failed. */
6729
- CHARGE_FAILED = "CHARGE_FAILED",
6730
- /** Payment details expired. */
6731
- EXPIRED = "EXPIRED",
6732
- /** Insufficient funds. */
6733
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6734
- /** Gift card was disabled before charge was attempted. */
6735
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6736
- }
6737
- /** @enumType */
6738
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6739
- interface VoidedStatusDetails {
6740
- reason?: VoidedReasonWithLiterals;
6741
- }
6742
- declare enum VoidedReason {
6743
- /** Payment was voided by merchant request. */
6744
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
6745
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6746
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6747
- }
6748
- /** @enumType */
6749
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6750
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6751
- /** @internal */
6752
- canceled?: CanceledStatusDetails;
6753
- /** @internal */
6754
- declined?: DeclinedStatusDetails;
6755
- /** @internal */
6756
- voided?: VoidedStatusDetails;
6848
+ BRANDED_FIRST = "BRANDED_FIRST",
6849
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6850
+ NOWNIA = "NOWNIA",
6757
6851
  /**
6758
- * Reason code from the payment gateway.
6759
- * @internal
6760
- * @minLength 1
6761
- * @maxLength 10
6852
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
6853
+ * The Partners company owns this namespace.
6762
6854
  */
6763
- paymentGatewayReasonCode?: string | null;
6764
- }
6765
- /** @oneof */
6766
- interface PaymentStatusDetailsStatusDetailsOneOf {
6767
- /** @internal */
6768
- canceled?: CanceledStatusDetails;
6769
- /** @internal */
6770
- declined?: DeclinedStatusDetails;
6771
- /** @internal */
6772
- voided?: VoidedStatusDetails;
6773
- }
6774
- interface Refund {
6855
+ UGC_TEMPLATE = "UGC_TEMPLATE",
6856
+ /** Codux Headless Sites */
6857
+ CODUX = "CODUX",
6858
+ /** Bobb - AI Design Creator. */
6859
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6775
6860
  /**
6776
- * Refund ID.
6777
- * @format GUID
6778
- * @readonly
6861
+ * Shared Blog Site is a unique single site across Enterprise account,
6862
+ * This site will hold all Blog posts related to the Marketing product.
6779
6863
  */
6780
- _id?: string;
6864
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6865
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6866
+ STANDALONE_FORMS = "STANDALONE_FORMS",
6867
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6868
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
6869
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6870
+ MIMIR = "MIMIR",
6871
+ /** Wix Twins platform. */
6872
+ TWINS = "TWINS",
6873
+ /** Wix Nano. */
6874
+ NANO = "NANO",
6875
+ /** Base44 headless sites. */
6876
+ BASE44 = "BASE44",
6877
+ /** Wix Channels Sites */
6878
+ CHANNELS = "CHANNELS",
6879
+ /** Nautilus platform. */
6880
+ NAUTILUS = "NAUTILUS",
6781
6881
  /**
6782
- * List of transactions.
6783
- * @maxSize 50
6882
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6883
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6784
6884
  */
6785
- transactions?: RefundTransaction[];
6786
- /** Refund business details. */
6787
- details?: RefundDetails;
6885
+ SYMPHONY = "SYMPHONY",
6886
+ /** Nautilus platform app. */
6887
+ NAUTILUS_APPS = "NAUTILUS_APPS",
6788
6888
  /**
6789
- * 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.
6790
- * @readonly
6791
- * @immutable
6889
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6890
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6792
6891
  */
6793
- _createdDate?: Date | null;
6892
+ VIBU = "VIBU",
6794
6893
  /**
6795
- * Aggregated refund summary.
6796
- * @readonly
6894
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6895
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
6896
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6897
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
6797
6898
  */
6798
- summary?: AggregatedRefundSummary;
6899
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6799
6900
  /**
6800
- * ID of the app that initiated this refund.
6801
- * @format GUID
6802
- * @readonly
6803
- * @immutable
6901
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
6902
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6804
6903
  */
6805
- requestingServiceAppId?: string | null;
6904
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6806
6905
  }
6807
- interface RefundTransaction {
6906
+ /** @enumType */
6907
+ 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';
6908
+ /** Site transferred to another user. */
6909
+ interface SiteTransferred {
6808
6910
  /**
6809
- * ID of the payment associated with this refund.
6911
+ * A previous owner id (user that transfers meta site).
6810
6912
  * @format GUID
6811
- * @immutable
6812
- */
6813
- paymentId?: string;
6814
- /**
6815
- * Refund amount.
6816
- * @immutable
6817
6913
  */
6818
- amount?: Price;
6819
- /** Refund status. */
6820
- refundStatus?: RefundStatusWithLiterals;
6821
- /** Optional details of current refund status. */
6822
- refundStatusInfo?: RefundStatusInfo;
6914
+ oldOwnerId?: string;
6823
6915
  /**
6824
- * Payment gateway's refund ID.
6825
- * This field is only returned when the value of `external_refund` is `false`.
6916
+ * A new owner id (user that accepts meta site).
6826
6917
  * @format GUID
6827
6918
  */
6828
- gatewayRefundId?: string | null;
6829
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6830
- providerRefundId?: string | null;
6919
+ newOwnerId?: string;
6920
+ }
6921
+ /** Soft deletion of the meta site. Could be restored. */
6922
+ interface SiteDeleted {
6923
+ /** A deletion context. */
6924
+ deleteContext?: DeleteContext;
6925
+ }
6926
+ interface DeleteContext {
6927
+ /** When the meta site was deleted. */
6928
+ dateDeleted?: Date | null;
6929
+ /** A status. */
6930
+ deleteStatus?: DeleteStatusWithLiterals;
6831
6931
  /**
6832
- * Whether refund was made externally and manually on the payment provider's side.
6833
- * @immutable
6932
+ * A reason (flow).
6933
+ * @maxLength 255
6834
6934
  */
6835
- externalRefund?: boolean;
6935
+ deleteOrigin?: string;
6836
6936
  /**
6837
- * Location where the refund was processed.
6838
- * @internal
6839
- * @format GUID
6840
- * @immutable
6937
+ * A service that deleted it.
6938
+ * @maxLength 255
6841
6939
  */
6842
- locationId?: string | null;
6940
+ initiatorId?: string | null;
6843
6941
  }
6844
- /** Refund transaction status. */
6845
- declare enum RefundStatus {
6846
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6847
- PENDING = "PENDING",
6848
- /** Refund transaction succeeded. */
6849
- SUCCEEDED = "SUCCEEDED",
6850
- /** Refund transaction failed. */
6851
- FAILED = "FAILED",
6852
- /** Refund request acknowledged, and will be executed soon. */
6853
- SCHEDULED = "SCHEDULED",
6854
- /** Refund was initiated on payment provider side. */
6855
- STARTED = "STARTED"
6942
+ declare enum DeleteStatus {
6943
+ UNKNOWN = "UNKNOWN",
6944
+ TRASH = "TRASH",
6945
+ DELETED = "DELETED",
6946
+ PENDING_PURGE = "PENDING_PURGE",
6947
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6856
6948
  }
6857
6949
  /** @enumType */
6858
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6859
- interface RefundStatusInfo {
6860
- /**
6861
- * Reason code for the refund's current status.
6862
- *
6863
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6864
- * @minLength 1
6865
- * @maxLength 10
6866
- */
6867
- paymentGatewayReasonCode?: string | null;
6950
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6951
+ /** Restoration of the meta site. */
6952
+ interface SiteUndeleted {
6953
+ }
6954
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
6955
+ interface SitePublished {
6956
+ }
6957
+ interface SiteUnpublished {
6868
6958
  /**
6869
- * Free text explanation of current refund status.
6870
- * @minLength 1
6871
- * @maxLength 1000
6959
+ * A list of URLs previously associated with the meta site.
6960
+ * @maxLength 4000
6961
+ * @maxSize 10000
6872
6962
  */
6873
- description?: string | null;
6963
+ urls?: string[];
6874
6964
  }
6875
- interface AggregatedRefundSummary {
6876
- /** Total amount requested for refund. */
6877
- requestedRefund?: Price;
6878
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6879
- pendingRefund?: Price;
6880
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6881
- refunded?: Price;
6882
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
6883
- failedRefundAmount?: Price;
6884
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
6885
- pending?: boolean;
6886
- /** Breakdown of refunded items. Available only after refund is complete. */
6887
- breakdown?: RefundItemsBreakdown;
6965
+ interface SiteMarkedAsTemplate {
6888
6966
  }
6889
- interface RefundItemsBreakdown {
6967
+ interface SiteMarkedAsWixSite {
6968
+ }
6969
+ /**
6970
+ * Represents a service provisioned a site.
6971
+ *
6972
+ * Note on `origin_instance_id`:
6973
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6974
+ * This is because of the following scenario:
6975
+ *
6976
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
6977
+ * such as a product catalog. When you create a site from this template, you inherit this
6978
+ * default product catalog. However, if the template's product catalog is modified,
6979
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
6980
+ * your site remains consistent with what you initially received and does not include any
6981
+ * changes made to the original template afterward.
6982
+ * To ensure this, the TPA on the template gets a new instance_id.
6983
+ */
6984
+ interface ServiceProvisioned {
6890
6985
  /**
6891
- * Refunded line items and the amount refunded for each.
6892
- * @maxSize 300
6986
+ * Either UUID or EmbeddedServiceType.
6987
+ * @maxLength 36
6893
6988
  */
6894
- lineItems?: LineItemRefundSummary[];
6895
- }
6896
- interface LineItemRefundSummary {
6989
+ appDefId?: string;
6897
6990
  /**
6898
- * ID of the refunded line item.
6899
- * @format GUID
6991
+ * Not only UUID. Something here could be something weird.
6992
+ * @maxLength 36
6900
6993
  */
6901
- lineItemId?: string;
6902
- /** Total refunded amount for the line item. */
6903
- totalRefundedAmount?: Price;
6904
- }
6905
- interface CalculateRefundRequest {
6994
+ instanceId?: string;
6906
6995
  /**
6907
- * Order ID
6908
- * @minLength 1
6909
- * @maxLength 100
6996
+ * An instance id from which this instance is originated.
6997
+ * @maxLength 36
6910
6998
  */
6911
- ecomOrderId?: string;
6999
+ originInstanceId?: string;
6912
7000
  /**
6913
- * Refunded line items and quantity
6914
- * @maxSize 300
7001
+ * A version.
7002
+ * @maxLength 500
6915
7003
  */
6916
- refundItems?: CalculateRefundItemRequest[];
6917
- /** Should include shipping in refund calculation */
6918
- refundShipping?: boolean;
6919
- }
6920
- interface CalculateRefundItemRequest {
7004
+ version?: string | null;
6921
7005
  /**
6922
- * ID of the line item being refunded
7006
+ * The origin meta site id
6923
7007
  * @format GUID
6924
7008
  */
6925
- _id?: string;
7009
+ originMetaSiteId?: string | null;
7010
+ }
7011
+ interface ServiceRemoved {
6926
7012
  /**
6927
- * How much of that line item is being refunded
6928
- * @min 1
6929
- * @max 100000
7013
+ * Either UUID or EmbeddedServiceType.
7014
+ * @maxLength 36
6930
7015
  */
6931
- quantity?: number;
6932
- }
6933
- interface CalculateRefundResponse {
6934
- /** Total refundable amount */
6935
- total?: Price;
6936
- /** Tax cost of the order */
6937
- tax?: Price;
6938
- /** Discount given for this order */
6939
- discount?: Price;
6940
- /** Total cost of the order (without tax) */
6941
- subtotal?: Price;
6942
- /** Total shipping cost for order */
6943
- shipping?: Price;
6944
- /** Previous refund given on that order */
6945
- previouslyRefundedAmount?: Price;
7016
+ appDefId?: string;
6946
7017
  /**
6947
- * The refundable items of that order
6948
- * @maxSize 300
7018
+ * Not only UUID. Something here could be something weird.
7019
+ * @maxLength 36
6949
7020
  */
6950
- items?: CalculateRefundItemResponse[];
6951
- }
6952
- interface CalculateRefundItemResponse {
7021
+ instanceId?: string;
6953
7022
  /**
6954
- * Line item ID
6955
- * @format GUID
7023
+ * A version.
7024
+ * @maxLength 500
6956
7025
  */
6957
- _id?: string;
6958
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6959
- price?: Price;
7026
+ version?: string | null;
6960
7027
  }
6961
- interface VoidAuthorizedPaymentsRequest {
7028
+ /** Rename of the site. Meaning, free public url has been changed as well. */
7029
+ interface SiteRenamed {
6962
7030
  /**
6963
- * Wix eCommerce order ID
6964
- * @minLength 1
6965
- * @maxLength 100
7031
+ * A new meta site name (URL slug).
7032
+ * @maxLength 20
6966
7033
  */
6967
- ecomOrderId: string;
7034
+ newSiteName?: string;
6968
7035
  /**
6969
- * Payment IDs
6970
- * @minSize 1
6971
- * @maxSize 100
6972
- * @format GUID
7036
+ * A previous meta site name (URL slug).
7037
+ * @maxLength 255
6973
7038
  */
6974
- paymentIds: string[];
7039
+ oldSiteName?: string;
6975
7040
  }
6976
- interface VoidAuthorizedPaymentsResponse {
6977
- /** All order's transactions after the void was triggered */
6978
- orderTransactions?: OrderTransactions;
7041
+ /**
7042
+ * Hard deletion of the meta site.
7043
+ *
7044
+ * Could not be restored. Therefore it's desirable to cleanup data.
7045
+ */
7046
+ interface SiteHardDeleted {
7047
+ /** A deletion context. */
7048
+ deleteContext?: DeleteContext;
6979
7049
  }
6980
- interface CaptureAuthorizedPaymentsRequest {
6981
- /**
6982
- * Wix eCommerce order ID
6983
- * @minLength 1
6984
- * @maxLength 100
6985
- */
6986
- ecomOrderId: string;
7050
+ interface NamespaceChanged {
7051
+ /** A previous namespace. */
7052
+ oldNamespace?: NamespaceWithLiterals;
7053
+ /** A new namespace. */
7054
+ newNamespace?: NamespaceWithLiterals;
7055
+ }
7056
+ /** Assigned Studio editor */
7057
+ interface StudioAssigned {
7058
+ }
7059
+ /** Unassigned Studio editor */
7060
+ interface StudioUnassigned {
7061
+ }
7062
+ /**
7063
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
7064
+ *
7065
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
7066
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
7067
+ *
7068
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
7069
+ */
7070
+ interface SiteUrlChanged {
7071
+ }
7072
+ /**
7073
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
7074
+ * Consumed by other teams to remove relevant data.
7075
+ */
7076
+ interface SitePurgedExternally {
6987
7077
  /**
6988
- * Capture payments information
6989
- * @minSize 1
7078
+ * @maxLength 2048
6990
7079
  * @maxSize 100
7080
+ * @deprecated
7081
+ * @targetRemovalDate 2025-04-15
6991
7082
  */
6992
- payments: PaymentCapture[];
7083
+ appDefId?: string[];
6993
7084
  }
6994
- interface PaymentCapture {
6995
- /**
6996
- * Payment ID
6997
- * @format GUID
6998
- */
6999
- paymentId?: string | null;
7000
- /**
7001
- * Capture amount.
7002
- * If not provided - full authorized amount will be captured.
7003
- */
7004
- amount?: Price;
7085
+ /** Assigned Odeditor */
7086
+ interface OdeditorAssigned {
7005
7087
  }
7006
- interface CaptureAuthorizedPaymentsResponse {
7007
- /** All order's transactions after the capture was triggered */
7008
- orderTransactions?: OrderTransactions;
7088
+ /** Unassigned Odeditor */
7089
+ interface OdeditorUnassigned {
7009
7090
  }
7010
- interface ChargeSavedPaymentMethodRequest {
7011
- /**
7012
- * Ecom Order ID.
7013
- * @minLength 1
7014
- * @maxLength 100
7015
- */
7016
- ecomOrderId?: string;
7017
- /** Amount to be charged */
7018
- amount?: Price;
7091
+ /** Assigned Picasso editor */
7092
+ interface PicassoAssigned {
7019
7093
  }
7020
- interface ChargeSavedPaymentMethodResponse {
7021
- /** Payment gateway's order ID (e.g Wix Payments) */
7022
- paymentGatewayOrderId?: string;
7094
+ /** Unassigned Picasso */
7095
+ interface PicassoUnassigned {
7023
7096
  }
7024
- interface V1TriggerReindexRequest {
7025
- /** @format GUID */
7026
- metasiteId?: string;
7027
- /**
7028
- * @minLength 1
7029
- * @maxLength 100
7030
- * @maxSize 100
7031
- */
7032
- orderIds?: string[];
7097
+ /** Assigned Wixel */
7098
+ interface WixelAssigned {
7033
7099
  }
7034
- interface V1TriggerReindexResponse {
7100
+ /** Unassigned Wixel */
7101
+ interface WixelUnassigned {
7035
7102
  }
7036
- interface V1TriggerReindexOrderRequest {
7037
- /** @format GUID */
7038
- metasiteId?: string;
7039
- /**
7040
- * @minLength 1
7041
- * @maxLength 100
7042
- */
7043
- orderId?: string;
7103
+ /** Assigned StudioTwo */
7104
+ interface StudioTwoAssigned {
7105
+ }
7106
+ /** Unassigned StudioTwo */
7107
+ interface StudioTwoUnassigned {
7108
+ }
7109
+ /** Media from user domain is enabled. */
7110
+ interface UserDomainMediaEnabled {
7111
+ }
7112
+ /** Media from user domain is disabled. */
7113
+ interface UserDomainMediaDisabled {
7114
+ }
7115
+ /** Assigned Editorless */
7116
+ interface EditorlessAssigned {
7117
+ }
7118
+ /** Unassigned Editorless */
7119
+ interface EditorlessUnassigned {
7120
+ }
7121
+ interface HasCustomEmailConfigurationsRequest {
7122
+ }
7123
+ interface HasCustomEmailConfigurationsResponse {
7124
+ hasCustomConfigurations?: boolean;
7125
+ }
7126
+ interface AddToAutomationMigrationPopulationRequest {
7127
+ /** When true, sends custom email configurations to automation system via email */
7128
+ sendCustomEmailConfigs?: boolean;
7129
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
7130
+ origin?: OriginWithLiterals;
7131
+ }
7132
+ declare enum Origin {
7133
+ OPT_IN = "OPT_IN",
7134
+ MIGRATION = "MIGRATION"
7135
+ }
7136
+ /** @enumType */
7137
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
7138
+ interface AddToAutomationMigrationPopulationResponse {
7139
+ success?: boolean;
7140
+ }
7141
+ interface IsInAutomationMigrationPopulationRequest {
7142
+ }
7143
+ interface IsInAutomationMigrationPopulationResponse {
7144
+ inPopulation?: boolean;
7044
7145
  }
7045
7146
  interface DiffmatokyPayload {
7046
7147
  left?: string;
@@ -10875,4 +10976,4 @@ interface BulkUpdateOrderTagsOptions {
10875
10976
  unassignTags?: TagsTags;
10876
10977
  }
10877
10978
 
10878
- export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, RefundableStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountReason as aD, LineItemQuantityChangeType as aE, ActivityType as aF, OrderActivityTypeEnumActivityType as aG, AttributionSource as aH, ChannelType as aI, AdditionalFeeSource as aJ, OrderActionType as aK, SpecificItemsCouponBehavior as aL, ChargeType as aM, VersioningMode as aN, DeltaPaymentOptionType as aO, InventoryAction as aP, WebhookIdentityType as aQ, PreviewEmailType as aR, State as aS, SiteCreatedContext as aT, Namespace as aU, DeleteStatus as aV, Origin as aW, ScheduledAction as aX, DurationUnit as aY, PaymentCollectabilityStatus as aZ, PredefinedPaymentMethod as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type CrossBorderPriceAdjustment as b$, NonRefundableReason as b0, ManuallyRefundableReason as b1, RestockType as b2, TransactionStatus as b3, AuthorizationCaptureStatus as b4, AuthorizationVoidStatus as b5, Reason as b6, ActionType as b7, ChargebackStatus as b8, MembershipPaymentStatus as b9, type ItemType as bA, type ItemTypeItemTypeDataOneOf as bB, type RestockLocation as bC, type ItemTaxFullDetails as bD, type LineItemTaxInfo as bE, type LineItemTaxBreakdown as bF, type DigitalFile as bG, type SubscriptionInfo as bH, type SubscriptionTitle as bI, type SubscriptionDescription as bJ, type SubscriptionSettings as bK, type FreeTrialPeriod as bL, type BillingSettings as bM, type BillingAdjustment as bN, type BillingAdjustmentPriceSummary as bO, type CyclePriceOverride as bP, type PriceDescription as bQ, type LocationAndQuantity as bR, type TaxableAddress as bS, type TaxableAddressTaxableAddressDataOneOf as bT, type DecimalQuantity as bU, type DecimalQuantityUnitOneOf as bV, type TranslatableString as bW, type ExtendedFields as bX, type ModifierGroup as bY, type ItemModifier as bZ, type ServiceProperties as b_, PaymentStatus as ba, CanceledReason as bb, DeclinedReason as bc, VoidedReason as bd, RefundStatus as be, SortOrder as bf, OrderApprovalStrategy as bg, Placement as bh, SubdivisionType as bi, SourceType as bj, CustomFieldGroup as bk, ValueType as bl, DepositType as bm, InvoiceStatus as bn, type OrderLineItem as bo, type ProductName as bp, type CatalogReference as bq, type DescriptionLine as br, type DescriptionLineValueOneOf as bs, type DescriptionLineDescriptionLineValueOneOf as bt, type DescriptionLineName as bu, type PlainTextValue as bv, type Color as bw, type FocalPoint as bx, type PhysicalProperties as by, type Dimensions as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundInitiated as c$, type BuyerInfo as c0, type BuyerInfoIdOneOf as c1, type CurrencyConversionDetails as c2, type CrossBorderRepricing as c3, type PriceSummary as c4, type AddressWithContact as c5, type Address as c6, type StreetAddress as c7, type AddressLocation as c8, type FullAddressContactDetails as c9, type MerchantComment as cA, type OrderRefunded as cB, type OrderCreatedFromExchange as cC, type NewExchangeOrderCreated as cD, type LineItemExchangeData as cE, type DraftOrderChangesApplied as cF, type OrderChange as cG, type OrderChangeValueOneOf as cH, type LineItemChanges as cI, type LineItemQuantityChange as cJ, type LineItemPriceChange as cK, type LineItemProductNameChange as cL, type LineItemDescriptionLineChange as cM, type LineItemModifiersChange as cN, type ManagedLineItem as cO, type ManagedDiscount as cP, type TranslatedValue as cQ, type LineItemAmount as cR, type ManagedAdditionalFee as cS, type TotalPriceChange as cT, type ShippingInformationChange as cU, type ShippingInformation as cV, type PricesRecalculatedForDestination as cW, type SavedPaymentMethod as cX, type AuthorizedPaymentCreated as cY, type AuthorizedPaymentCaptured as cZ, type AuthorizedPaymentVoided as c_, type VatId as ca, type V1ShippingInformation as cb, type DeliveryLogistics as cc, type DeliveryLogisticsAddressOneOf as cd, type PickupDetails as ce, type PickupAddress as cf, type DeliveryTimeSlot as cg, type ShippingPrice as ch, type ShippingRegion as ci, type TaxSummary as cj, type OrderTaxInfo as ck, type OrderTaxBreakdown as cl, type CrossBorderCalculation as cm, type AppliedDiscount as cn, type AppliedDiscountDiscountSourceOneOf as co, type Coupon as cp, type MerchantDiscount as cq, type MerchantDiscountMerchantDiscountReasonOneOf as cr, type DiscountRule as cs, type DiscountRuleName as ct, type LineItemDiscount as cu, type ItemCombination as cv, type ItemCombinationLineItem as cw, type Activity as cx, type ActivityContentOneOf as cy, type CustomActivity as cz, type PreparePaymentCollectionOptions as d, type OrderImported as d$, type RefundedPayment as d0, type RefundedPaymentKindOneOf as d1, type RegularPaymentRefund as d2, type GiftCardPaymentRefund as d3, type MembershipPaymentRefund as d4, type PaymentRefunded as d5, type PaymentRefundFailed as d6, type RefundedAsStoreCredit as d7, type PaymentPending as d8, type PaymentPendingPaymentDetailsOneOf as d9, type TagList as dA, type Location as dB, type OrderSettings as dC, type OrderSettingsAllowedActionsOneOf as dD, type OrderSettingsEditableByOneOf as dE, type CustomAllowedActions as dF, type OwnerApps as dG, type FormInfo as dH, type FormIdentifier as dI, type PlatformFeeSummary as dJ, type PlatformFee as dK, type UpdateInternalDocumentsEvent as dL, type UpdateInternalDocumentsEventOperationOneOf as dM, type InternalDocument as dN, type InternalDocumentUpdateOperation as dO, type DeleteByIdsOperation as dP, type DeleteByFilterOperation as dQ, type InternalDocumentUpdateByFilterOperation as dR, type InternalUpdateExistingOperation as dS, type VersionedDocumentUpdateOperation as dT, type VersionedDeleteByIdsOperation as dU, type VersionedDocumentId as dV, type OrderApproved as dW, type OrdersExperiments as dX, type OrderRejectedEventOrderRejected as dY, type OrderItemsRestocked as dZ, type V1RestockItem as d_, type RegularPayment as da, type RegularPaymentPaymentMethodDetailsOneOf as db, type CreditCardDetails as dc, type PaymentCanceled as dd, type PaymentCanceledPaymentDetailsOneOf as de, type PaymentDeclined as df, type PaymentDeclinedPaymentDetailsOneOf as dg, type ReceiptCreated as dh, type ReceiptCreatedReceiptInfoOneOf as di, type WixReceipt as dj, type ExternalReceipt as dk, type ReceiptSent as dl, type ReceiptSentReceiptInfoOneOf as dm, type ChargebackCreated as dn, type ChargebackReversed as dp, type CreatedBy as dq, type CreatedByStringOneOf as dr, type ChannelInfo as ds, type CustomField as dt, type BalanceSummary as du, type Balance as dv, type CashRounding as dw, type AdditionalFee as dx, type FulfillmentStatusesAggregate as dy, type Tags as dz, type PreparePaymentCollectionResponse as e, type RefundItem as e$, type ImportedOrderDeleted as e0, type PaymentStatusUpdated as e1, type FulfillmentStatusUpdated as e2, type OrderCanceledEventOrderCanceled as e3, type OrderDeltasCommitted as e4, type CommittedDiffs as e5, type CommittedDiffsShippingUpdateInfoOneOf as e6, type ItemChangedDetails as e7, type OrderLineItemChangedDetails as e8, type DecimalQuantityUpdate as e9, type BulkDeleteImportedOrdersRequest as eA, type SendBuyerConfirmationEmailRequest as eB, type SendBuyerConfirmationEmailResponse as eC, type SendBuyerPaymentsReceivedEmailRequest as eD, type SendBuyerPaymentsReceivedEmailResponse as eE, type SendBuyerPickupConfirmationEmailRequest as eF, type SendBuyerPickupConfirmationEmailResponse as eG, type BulkSendBuyerPickupConfirmationEmailsRequest as eH, type BulkSendBuyerPickupConfirmationEmailsResponse as eI, type SendBuyerShippingConfirmationEmailRequest as eJ, type SendBuyerShippingConfirmationEmailResponse as eK, type BulkSendBuyerShippingConfirmationEmailsRequest as eL, type BulkSendBuyerShippingConfirmationEmailsResponse as eM, type SendMerchantOrderReceivedNotificationRequest as eN, type SendMerchantOrderReceivedNotificationResponse as eO, type SendCancelRefundEmailRequest as eP, type SendCancelRefundEmailResponse as eQ, type SendRefundEmailRequest as eR, type SendRefundEmailResponse as eS, type SendFulfillmentEmailRequest as eT, type SendFulfillmentEmailResponse as eU, type SendMerchantOrderReceivedPushRequest as eV, type SendMerchantOrderReceivedPushResponse as eW, type PreviewEmailByTypeRequest as eX, type PreviewEmailByTypeResponse as eY, type PreviewRefundEmailRequest as eZ, type RefundDetails as e_, type CrossBorderAdjustmentUpdate as ea, type LineItemDelta as eb, type LineItemDeltaDeltaOneOf as ec, type AppliedDiscountDelta as ed, type AppliedDiscountDeltaDeltaOneOf as ee, type AdditionalFeeDelta as ef, type AdditionalFeeDeltaDeltaOneOf as eg, type DraftOrderCommitSettings as eh, type InventoryUpdateDetails as ei, type TriggerReindexRequest as ej, type TriggerReindexResponse as ek, type DomainEvent as el, type DomainEventBodyOneOf as em, type EntityCreatedEvent as en, type RestoreInfo as eo, type EntityUpdatedEvent as ep, type EntityDeletedEvent as eq, type ActionEvent as er, type Empty as es, type TriggerReindexOrderRequest as et, type MessageEnvelope as eu, type IdentificationData as ev, type IdentificationDataIdOneOf as ew, type AccountInfo as ex, type ImportOrderRequest as ey, type SetOrderNumberCounterRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type UserDefinedPaymentMethodName as f$, type LineItemRefund as f0, type AdditionalFeeRefund as f1, type ShippingRefund as f2, type PreviewRefundEmailResponse as f3, type PreviewCancelEmailRequest as f4, type PreviewCancelEmailResponse as f5, type PreviewCancelRefundEmailRequest as f6, type PreviewCancelRefundEmailResponse as f7, type PreviewBuyerPaymentsReceivedEmailRequest as f8, type PreviewBuyerPaymentsReceivedEmailResponse as f9, type StudioUnassigned as fA, type SiteUrlChanged as fB, type SitePurgedExternally as fC, type OdeditorAssigned as fD, type OdeditorUnassigned as fE, type PicassoAssigned as fF, type PicassoUnassigned as fG, type WixelAssigned as fH, type WixelUnassigned as fI, type StudioTwoAssigned as fJ, type StudioTwoUnassigned as fK, type UserDomainMediaEnabled as fL, type UserDomainMediaDisabled as fM, type EditorlessAssigned as fN, type EditorlessUnassigned as fO, type HasCustomEmailConfigurationsRequest as fP, type HasCustomEmailConfigurationsResponse as fQ, type AddToAutomationMigrationPopulationRequest as fR, type AddToAutomationMigrationPopulationResponse as fS, type IsInAutomationMigrationPopulationRequest as fT, type IsInAutomationMigrationPopulationResponse as fU, type PreparePaymentCollectionRequest as fV, type RedirectUrls as fW, type DelayedCaptureSettings as fX, type Duration as fY, type GetPaymentCollectabilityStatusRequest as fZ, type RecordManuallyCollectedPaymentRequest as f_, type PreviewBuyerConfirmationEmailRequest as fa, type PreviewBuyerConfirmationEmailResponse as fb, type PreviewBuyerPickupConfirmationEmailRequest as fc, type PreviewBuyerPickupConfirmationEmailResponse as fd, type PreviewShippingConfirmationEmailRequest as fe, type PreviewShippingConfirmationEmailResponse as ff, type PreviewResendDownloadLinksEmailRequest as fg, type PreviewResendDownloadLinksEmailResponse as fh, type MetaSiteSpecialEvent as fi, type MetaSiteSpecialEventPayloadOneOf as fj, type Asset as fk, type SiteCreated as fl, type SiteTransferred as fm, type SiteDeleted as fn, type DeleteContext as fo, type SiteUndeleted as fp, type SitePublished as fq, type SiteUnpublished as fr, type SiteMarkedAsTemplate as fs, type SiteMarkedAsWixSite as ft, type ServiceProvisioned as fu, type ServiceRemoved as fv, type SiteRenamed as fw, type SiteHardDeleted as fx, type NamespaceChanged as fy, type StudioAssigned as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type V1TriggerReindexOrderRequest as g$, type UserDefinedPaymentMethodNameKindOneOf as g0, type RecordManuallyCollectedPaymentResponse as g1, type MarkOrderAsPaidRequest as g2, type BulkMarkOrdersAsPaidRequest as g3, type BulkOrderResult as g4, type ItemMetadata as g5, type ApplicationError as g6, type BulkActionMetadata as g7, type GetRefundabilityStatusRequest as g8, type Refundability as g9, type GiftCardPaymentDetails as gA, type MembershipPaymentDetails as gB, type FutureMembershipDetails as gC, type WixReceiptInfo as gD, type ExternalReceiptInfo as gE, type CashRoundingDetails as gF, type CanceledStatusDetails as gG, type DeclinedStatusDetails as gH, type VoidedStatusDetails as gI, type PaymentStatusDetails as gJ, type PaymentStatusDetailsStatusDetailsOneOf as gK, type Refund as gL, type RefundTransaction as gM, type RefundStatusInfo as gN, type AggregatedRefundSummary as gO, type RefundItemsBreakdown as gP, type LineItemRefundSummary as gQ, type CalculateRefundRequest as gR, type CalculateRefundItemRequest as gS, type CalculateRefundResponse as gT, type CalculateRefundItemResponse as gU, type VoidAuthorizedPaymentsRequest as gV, type CaptureAuthorizedPaymentsRequest as gW, type ChargeSavedPaymentMethodRequest as gX, type ChargeSavedPaymentMethodResponse as gY, type V1TriggerReindexRequest as gZ, type V1TriggerReindexResponse as g_, type RefundabilityAdditionalRefundabilityInfoOneOf as ga, type CreatePaymentGatewayOrderRequest as gb, type ChargedBy as gc, type ChargeMembershipsRequest as gd, type MembershipChargeItem as ge, type MembershipName as gf, type ChargeMembershipsResponse as gg, type TriggerRefundRequest as gh, type RefundSideEffects as gi, type RestockInfo as gj, type RestockItem as gk, type OrderTransactions as gl, type Payment as gm, type PaymentPaymentDetailsOneOf as gn, type PaymentReceiptInfoOneOf as go, type PaymentStatusDetailsOneOf as gp, type RegularPaymentDetails as gq, type RegularPaymentDetailsPaymentMethodDetailsOneOf as gr, type CreditCardPaymentMethodDetails as gs, type AuthorizationDetails as gt, type AuthorizationCapture as gu, type AuthorizationActionFailureDetails as gv, type AuthorizationVoid as gw, type V1ScheduledAction as gx, type Chargeback as gy, type PaymentMethodName as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type InternalActivityContentOneOf as h$, type DiffmatokyPayload as h0, type ErrorInformation as h1, type GetOrderRequest as h2, type GetOrderResponse as h3, type InternalQueryOrdersRequest as h4, type PlatformQuery as h5, type PlatformQueryPagingMethodOneOf as h6, type Sorting as h7, type PlatformPaging as h8, type CursorPaging as h9, type ArchiveOrderRequest as hA, type ArchiveOrderResponse as hB, type BulkArchiveOrdersRequest as hC, type BulkArchiveOrdersResponse as hD, type BulkArchiveOrdersByFilterRequest as hE, type BulkArchiveOrdersByFilterResponse as hF, type UnArchiveOrderRequest as hG, type UnArchiveOrderResponse as hH, type BulkUnArchiveOrdersRequest as hI, type BulkUnArchiveOrdersResponse as hJ, type BulkUnArchiveOrdersByFilterRequest as hK, type BulkUnArchiveOrdersByFilterResponse as hL, type UpdateBuyerInfoRequest as hM, type BuyerInfoUpdate as hN, type UpdateBuyerInfoResponse as hO, type UpdateBuyerEmailRequest as hP, type UpdateBuyerEmailResponse as hQ, type UpdateOrderShippingAddressRequest as hR, type UpdateOrderShippingAddressResponse as hS, type UpdateBillingContactDetailsRequest as hT, type UpdateBillingContactDetailsResponse as hU, type UpdateOrderLineItemRequest as hV, type UpdateOrderLineItemsRequest as hW, type MaskedOrderLineItem as hX, type UpdateOrderLineItemsResponse as hY, type AddInternalActivityRequest as hZ, type InternalActivity as h_, type InternalQueryOrdersResponse as ha, type PlatformPagingMetadata as hb, type Cursors as hc, type QueryOrderRequest as hd, type QueryOrderResponse as he, type SearchOrdersRequest as hf, type CursorSearch as hg, type CursorSearchPagingMethodOneOf as hh, type CursorPagingMetadata as hi, type CreateOrderRequest as hj, type OrderCreationSettings as hk, type OrderCreationSettingsEditableByOneOf as hl, type OrderCreateNotifications as hm, type CreateOrderResponse as hn, type UpdateOrderRequest as ho, type UpdateOrderResponse as hp, type BulkUpdateOrdersRequest as hq, type CommitDeltasRequest as hr, type DraftOrderDiffs as hs, type DraftOrderDiffsShippingUpdateInfoOneOf as ht, type DraftOrderDiffsBuyerUpdateInfoOneOf as hu, type DraftOrderDiffsBillingUpdateInfoOneOf as hv, type DraftOrderDiffsRecipientUpdateInfoOneOf as hw, type V1LineItemDelta as hx, type V1LineItemDeltaDeltaOneOf as hy, type CommitDeltasResponse as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type TagsTagList as i$, type OrderPlaced as i0, type OrderPaid as i1, type OrderFulfilled as i2, type OrderNotFulfilled as i3, type OrderCanceled as i4, type DownloadLinkSent as i5, type TrackingNumberAdded as i6, type TrackingNumberEdited as i7, type TrackingLinkAdded as i8, type ShippingConfirmationEmailSent as i9, type BulkMarkAsFulfilledRequest as iA, type BulkMarkAsFulfilledResponse as iB, type BulkMarkAsFulfilledByFilterRequest as iC, type BulkMarkAsFulfilledByFilterResponse as iD, type MarkAsUnfulfilledRequest as iE, type MarkAsUnfulfilledResponse as iF, type BulkMarkAsUnfulfilledRequest as iG, type BulkMarkAsUnfulfilledResponse as iH, type BulkMarkAsUnfulfilledByFilterRequest as iI, type BulkMarkAsUnfulfilledByFilterResponse as iJ, type BulkSetBusinessLocationRequest as iK, type BulkSetBusinessLocationResponse as iL, type BulkSetBusinessLocationResult as iM, type V1MarkOrderAsPaidRequest as iN, type V1MarkOrderAsPaidResponse as iO, type V1BulkMarkOrdersAsPaidRequest as iP, type V1BulkMarkOrdersAsPaidResponse as iQ, type V1CreatePaymentGatewayOrderRequest as iR, type V1CreatePaymentGatewayOrderResponse as iS, type GetShipmentsRequest as iT, type GetShipmentsResponse as iU, type AggregateOrdersRequest as iV, type DecrementItemsQuantityRequest as iW, type DecrementData as iX, type DecrementItemsQuantityResponse as iY, type BulkUpdateOrderTagsRequest as iZ, type TagsTags as i_, type InvoiceAdded as ia, type InvoiceSent as ib, type FulfillerEmailSent as ic, type ShippingAddressEdited as id, type EmailEdited as ie, type PickupReadyEmailSent as ig, type OrderPartiallyPaid as ih, type OrderPending as ii, type OrderRejected as ij, type AddInternalActivityResponse as ik, type AddActivityRequest as il, type PublicActivityContentOneOf as im, type AddActivitiesRequest as io, type UpdateActivityRequest as ip, type DeleteActivityRequest as iq, type UpdateLineItemsDescriptionLinesRequest as ir, type LineItemUpdate as is, type UpdateLineItemsDescriptionLinesResponse as it, type MarkOrderAsSeenByHumanRequest as iu, type MarkOrderAsSeenByHumanResponse as iv, type CancelOrderRequest as iw, type UpdateOrderStatusRequest as ix, type MarkAsFulfilledRequest as iy, type MarkAsFulfilledResponse as iz, type BulkMarkOrdersAsPaidResponse as j, type FulfillmentStatusWithLiterals as j$, type BulkUpdateOrderTagsResult as j0, type SendOrderUpdatedDomainEventRequest as j1, type SendOrderUpdatedDomainEventResponse as j2, type Task as j3, type TaskKey as j4, type TaskAction as j5, type TaskActionActionOneOf as j6, type Complete as j7, type Cancel as j8, type Reschedule as j9, type CalculatedTaxes as jA, type CalculatedTax as jB, type Payments as jC, type InvoicesPayment as jD, type MetaData as jE, type InvoiceDynamicPriceTotals as jF, type CustomFieldValue as jG, type Value as jH, type Deposit as jI, type BaseEventMetadata as jJ, type EventMetadata as jK, type AccountInfoMetadata as jL, type OrderSearchSpec as jM, utils as jN, type DescriptionLineTypeWithLiterals as jO, type DimensionsUnitWithLiterals as jP, type ItemTypePresetWithLiterals as jQ, type PaymentOptionTypeWithLiterals as jR, type JurisdictionTypeWithLiterals as jS, type SubscriptionFrequencyWithLiterals as jT, type ProductPeriodAlignmentWithLiterals as jU, type AdjustmentTypeWithLiterals as jV, type TaxableAddressTypeWithLiterals as jW, type MeasurementUnitWithLiterals as jX, type RepriceStatusWithLiterals as jY, type BaseRateSourceWithLiterals as jZ, type PaymentStatusEnumPaymentStatusWithLiterals as j_, type InvoiceSentEvent as ja, type IdAndVersion as jb, type InvoiceFields as jc, type Customer as jd, type Email as je, type QuotesAddress as jf, type AddressDescription as jg, type Phone as jh, type Company as ji, type CommonAddress as jj, type CommonAddressStreetOneOf as jk, type Subdivision as jl, type StandardDetails as jm, type ShippingContactDetails as jn, type InvoiceDates as jo, type LineItems as jp, type LineItem as jq, type BigDecimalWrapper as jr, type LineItemTax as js, type Source as jt, type LineItemMetaData as ju, type Locale as jv, type TotalPrice as jw, type ItemizedFee as jx, type Discount as jy, type DiscountOneDiscountTypeOneOf as jz, type GetRefundabilityStatusResponse as k, onOrderPaymentStatusUpdated as k$, type WeightUnitWithLiterals as k0, type VatTypeWithLiterals as k1, type PickupMethodWithLiterals as k2, type CrossBorderNotApplicableReasonWithLiterals as k3, type CrossBorderRepricingModeWithLiterals as k4, type DiscountTypeWithLiterals as k5, type DiscountReasonWithLiterals as k6, type LineItemQuantityChangeTypeWithLiterals as k7, type ActivityTypeWithLiterals as k8, type OrderActivityTypeEnumActivityTypeWithLiterals as k9, type AuthorizationVoidStatusWithLiterals as kA, type ReasonWithLiterals as kB, type ActionTypeWithLiterals as kC, type ChargebackStatusWithLiterals as kD, type MembershipPaymentStatusWithLiterals as kE, type PaymentStatusWithLiterals as kF, type CanceledReasonWithLiterals as kG, type DeclinedReasonWithLiterals as kH, type VoidedReasonWithLiterals as kI, type RefundStatusWithLiterals as kJ, type SortOrderWithLiterals as kK, type OrderApprovalStrategyWithLiterals as kL, type PlacementWithLiterals as kM, type SubdivisionTypeWithLiterals as kN, type SourceTypeWithLiterals as kO, type CustomFieldGroupWithLiterals as kP, type ValueTypeWithLiterals as kQ, type DepositTypeWithLiterals as kR, type InvoiceStatusWithLiterals as kS, type CommonSearchWithEntityContext as kT, onOrderApproved as kU, onOrderCanceled as kV, onOrderCommitted as kW, onOrderCreated as kX, onOrderFulfilled as kY, onOrderImported as kZ, onOrderImportedOrderDeleted as k_, type AttributionSourceWithLiterals as ka, type ChannelTypeWithLiterals as kb, type AdditionalFeeSourceWithLiterals as kc, type OrderActionTypeWithLiterals as kd, type SpecificItemsCouponBehaviorWithLiterals as ke, type ChargeTypeWithLiterals as kf, type VersioningModeWithLiterals as kg, type DeltaPaymentOptionTypeWithLiterals as kh, type InventoryActionWithLiterals as ki, type WebhookIdentityTypeWithLiterals as kj, type PreviewEmailTypeWithLiterals as kk, type StateWithLiterals as kl, type SiteCreatedContextWithLiterals as km, type NamespaceWithLiterals as kn, type DeleteStatusWithLiterals as ko, type OriginWithLiterals as kp, type ScheduledActionWithLiterals as kq, type DurationUnitWithLiterals as kr, type PaymentCollectabilityStatusWithLiterals as ks, type PredefinedPaymentMethodWithLiterals as kt, type RefundableStatusWithLiterals as ku, type NonRefundableReasonWithLiterals as kv, type ManuallyRefundableReasonWithLiterals as kw, type RestockTypeWithLiterals as kx, type TransactionStatusWithLiterals as ky, type AuthorizationCaptureStatusWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, onOrderUpdated as l0, importOrder as l1, setOrderNumberCounter as l2, bulkDeleteImportedOrders as l3, preparePaymentCollection as l4, getPaymentCollectabilityStatus as l5, recordManuallyCollectedPayment as l6, paymentCollectionMarkOrderAsPaid as l7, paymentCollectionBulkMarkOrdersAsPaid as l8, getRefundabilityStatus as l9, paymentCollectionCreatePaymentGatewayOrder as la, chargeMemberships as lb, triggerRefund as lc, voidAuthorizedPayments as ld, captureAuthorizedPayments as le, getOrder as lf, createOrder as lg, updateOrder as lh, bulkUpdateOrders as li, updateOrderLineItem as lj, addActivity as lk, addActivities as ll, updateActivity as lm, deleteActivity as ln, cancelOrder as lo, updateOrderStatus as lp, aggregateOrders as lq, bulkUpdateOrderTags as lr, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
10979
+ export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, AuthorizationCaptureStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountValueType as aD, DiscountReason as aE, LineItemQuantityChangeType as aF, ActivityType as aG, OrderActivityTypeEnumActivityType as aH, AttributionSource as aI, ChannelType as aJ, AdditionalFeeSource as aK, OrderActionType as aL, SpecificItemsCouponBehavior as aM, ChargeType as aN, VersioningMode as aO, DeltaPaymentOptionType as aP, InventoryAction as aQ, WebhookIdentityType as aR, ScheduledAction as aS, DurationUnit as aT, PaymentCollectabilityStatus as aU, PredefinedPaymentMethod as aV, RefundableStatus as aW, NonRefundableReason as aX, ManuallyRefundableReason as aY, RestockType as aZ, TransactionStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type ServiceProperties as b$, AuthorizationVoidStatus as b0, Reason as b1, ActionType as b2, ChargebackStatus as b3, MembershipPaymentStatus as b4, PaymentStatus as b5, CanceledReason as b6, DeclinedReason as b7, VoidedReason as b8, RefundStatus as b9, type Dimensions as bA, type ItemType as bB, type ItemTypeItemTypeDataOneOf as bC, type RestockLocation as bD, type ItemTaxFullDetails as bE, type LineItemTaxInfo as bF, type LineItemTaxBreakdown as bG, type DigitalFile as bH, type SubscriptionInfo as bI, type SubscriptionTitle as bJ, type SubscriptionDescription as bK, type SubscriptionSettings as bL, type FreeTrialPeriod as bM, type BillingSettings as bN, type BillingAdjustment as bO, type BillingAdjustmentPriceSummary as bP, type CyclePriceOverride as bQ, type PriceDescription as bR, type LocationAndQuantity as bS, type TaxableAddress as bT, type TaxableAddressTaxableAddressDataOneOf as bU, type DecimalQuantity as bV, type DecimalQuantityUnitOneOf as bW, type TranslatableString as bX, type ExtendedFields as bY, type ModifierGroup as bZ, type ItemModifier as b_, PreviewEmailType as ba, State as bb, SiteCreatedContext as bc, Namespace as bd, DeleteStatus as be, Origin as bf, SortOrder as bg, OrderApprovalStrategy as bh, Placement as bi, SubdivisionType as bj, SourceType as bk, CustomFieldGroup as bl, ValueType as bm, DepositType as bn, InvoiceStatus as bo, type OrderLineItem as bp, type ProductName as bq, type CatalogReference as br, type DescriptionLine as bs, type DescriptionLineValueOneOf as bt, type DescriptionLineDescriptionLineValueOneOf as bu, type DescriptionLineName as bv, type PlainTextValue as bw, type Color as bx, type FocalPoint as by, type PhysicalProperties as bz, type SetOrderNumberCounterApplicationErrors as c, type AuthorizedPaymentCreated as c$, type CrossBorderPriceAdjustment as c0, type BuyerInfo as c1, type BuyerInfoIdOneOf as c2, type CurrencyConversionDetails as c3, type CrossBorderRepricing as c4, type PriceSummary as c5, type AddressWithContact as c6, type Address as c7, type StreetAddress as c8, type AddressLocation as c9, type Activity as cA, type ActivityContentOneOf as cB, type CustomActivity as cC, type MerchantComment as cD, type OrderRefunded as cE, type OrderCreatedFromExchange as cF, type NewExchangeOrderCreated as cG, type LineItemExchangeData as cH, type DraftOrderChangesApplied as cI, type OrderChange as cJ, type OrderChangeValueOneOf as cK, type LineItemChanges as cL, type LineItemQuantityChange as cM, type LineItemPriceChange as cN, type LineItemProductNameChange as cO, type LineItemDescriptionLineChange as cP, type LineItemModifiersChange as cQ, type ManagedLineItem as cR, type ManagedDiscount as cS, type TranslatedValue as cT, type LineItemAmount as cU, type ManagedAdditionalFee as cV, type TotalPriceChange as cW, type ShippingInformationChange as cX, type ShippingInformation as cY, type PricesRecalculatedForDestination as cZ, type SavedPaymentMethod as c_, type FullAddressContactDetails as ca, type VatId as cb, type V1ShippingInformation as cc, type DeliveryLogistics as cd, type DeliveryLogisticsAddressOneOf as ce, type PickupDetails as cf, type PickupAddress as cg, type DeliveryTimeSlot as ch, type ShippingPrice as ci, type ShippingRegion as cj, type TaxSummary as ck, type OrderTaxInfo as cl, type OrderTaxBreakdown as cm, type CrossBorderCalculation as cn, type AppliedDiscount as co, type AppliedDiscountDiscountSourceOneOf as cp, type Coupon as cq, type CouponDiscountValueOneOf as cr, type MerchantDiscount as cs, type MerchantDiscountMerchantDiscountReasonOneOf as ct, type DiscountRule as cu, type DiscountRuleDiscountValueOneOf as cv, type DiscountRuleName as cw, type LineItemDiscount as cx, type ItemCombination as cy, type ItemCombinationLineItem as cz, type PreparePaymentCollectionOptions as d, type OrderRejectedEventOrderRejected as d$, type AuthorizedPaymentCaptured as d0, type AuthorizedPaymentVoided as d1, type RefundInitiated as d2, type RefundedPayment as d3, type RefundedPaymentKindOneOf as d4, type RegularPaymentRefund as d5, type GiftCardPaymentRefund as d6, type MembershipPaymentRefund as d7, type PaymentRefunded as d8, type PaymentRefundFailed as d9, type AdditionalFee as dA, type FulfillmentStatusesAggregate as dB, type Tags as dC, type TagList as dD, type Location as dE, type OrderSettings as dF, type OrderSettingsAllowedActionsOneOf as dG, type OrderSettingsEditableByOneOf as dH, type CustomAllowedActions as dI, type OwnerApps as dJ, type FormInfo as dK, type FormIdentifier as dL, type PlatformFeeSummary as dM, type PlatformFee as dN, type UpdateInternalDocumentsEvent as dO, type UpdateInternalDocumentsEventOperationOneOf as dP, type InternalDocument as dQ, type InternalDocumentUpdateOperation as dR, type DeleteByIdsOperation as dS, type DeleteByFilterOperation as dT, type InternalDocumentUpdateByFilterOperation as dU, type InternalUpdateExistingOperation as dV, type VersionedDocumentUpdateOperation as dW, type VersionedDeleteByIdsOperation as dX, type VersionedDocumentId as dY, type OrderApproved as dZ, type OrdersExperiments as d_, type RefundedAsStoreCredit as da, type PaymentPending as db, type PaymentPendingPaymentDetailsOneOf as dc, type RegularPayment as dd, type RegularPaymentPaymentMethodDetailsOneOf as de, type CreditCardDetails as df, type PaymentCanceled as dg, type PaymentCanceledPaymentDetailsOneOf as dh, type PaymentDeclined as di, type PaymentDeclinedPaymentDetailsOneOf as dj, type ReceiptCreated as dk, type ReceiptCreatedReceiptInfoOneOf as dl, type WixReceipt as dm, type ExternalReceipt as dn, type ReceiptSent as dp, type ReceiptSentReceiptInfoOneOf as dq, type ChargebackCreated as dr, type ChargebackReversed as ds, type CreatedBy as dt, type CreatedByStringOneOf as du, type ChannelInfo as dv, type CustomField as dw, type BalanceSummary as dx, type Balance as dy, type CashRounding as dz, type PreparePaymentCollectionResponse as e, type ChargeMembershipsRequest as e$, type OrderItemsRestocked as e0, type V1RestockItem as e1, type OrderImported as e2, type ImportedOrderDeleted as e3, type PaymentStatusUpdated as e4, type FulfillmentStatusUpdated as e5, type OrderCanceledEventOrderCanceled as e6, type OrderDeltasCommitted as e7, type CommittedDiffs as e8, type CommittedDiffsShippingUpdateInfoOneOf as e9, type AccountInfo as eA, type ImportOrderRequest as eB, type SetOrderNumberCounterRequest as eC, type BulkDeleteImportedOrdersRequest as eD, type V1TriggerReindexRequest as eE, type V1TriggerReindexResponse as eF, type V1TriggerReindexOrderRequest as eG, type PreparePaymentCollectionRequest as eH, type RedirectUrls as eI, type DelayedCaptureSettings as eJ, type Duration as eK, type GetPaymentCollectabilityStatusRequest as eL, type RecordManuallyCollectedPaymentRequest as eM, type UserDefinedPaymentMethodName as eN, type UserDefinedPaymentMethodNameKindOneOf as eO, type RecordManuallyCollectedPaymentResponse as eP, type MarkOrderAsPaidRequest as eQ, type BulkMarkOrdersAsPaidRequest as eR, type BulkOrderResult as eS, type ItemMetadata as eT, type ApplicationError as eU, type BulkActionMetadata as eV, type GetRefundabilityStatusRequest as eW, type Refundability as eX, type RefundabilityAdditionalRefundabilityInfoOneOf as eY, type CreatePaymentGatewayOrderRequest as eZ, type ChargedBy as e_, type ItemChangedDetails as ea, type OrderLineItemChangedDetails as eb, type DecimalQuantityUpdate as ec, type CrossBorderAdjustmentUpdate as ed, type LineItemDelta as ee, type LineItemDeltaDeltaOneOf as ef, type AppliedDiscountDelta as eg, type AppliedDiscountDeltaDeltaOneOf as eh, type AdditionalFeeDelta as ei, type AdditionalFeeDeltaDeltaOneOf as ej, type DraftOrderCommitSettings as ek, type InventoryUpdateDetails as el, type TriggerReindexRequest as em, type TriggerReindexResponse as en, type DomainEvent as eo, type DomainEventBodyOneOf as ep, type EntityCreatedEvent as eq, type RestoreInfo as er, type EntityUpdatedEvent as es, type EntityDeletedEvent as et, type ActionEvent as eu, type Empty as ev, type TriggerReindexOrderRequest as ew, type MessageEnvelope as ex, type IdentificationData as ey, type IdentificationDataIdOneOf as ez, type PreparePaymentCollectionApplicationErrors as f, type BulkSendBuyerShippingConfirmationEmailsResponse as f$, type MembershipChargeItem as f0, type MembershipName as f1, type ChargeMembershipsResponse as f2, type TriggerRefundRequest as f3, type RefundDetails as f4, type RefundItem as f5, type LineItemRefund as f6, type AdditionalFeeRefund as f7, type ShippingRefund as f8, type RefundSideEffects as f9, type PaymentStatusDetails as fA, type PaymentStatusDetailsStatusDetailsOneOf as fB, type Refund as fC, type RefundTransaction as fD, type RefundStatusInfo as fE, type AggregatedRefundSummary as fF, type RefundItemsBreakdown as fG, type LineItemRefundSummary as fH, type CalculateRefundRequest as fI, type CalculateRefundItemRequest as fJ, type CalculateRefundResponse as fK, type CalculateRefundItemResponse as fL, type VoidAuthorizedPaymentsRequest as fM, type CaptureAuthorizedPaymentsRequest as fN, type ChargeSavedPaymentMethodRequest as fO, type ChargeSavedPaymentMethodResponse as fP, type SendBuyerConfirmationEmailRequest as fQ, type SendBuyerConfirmationEmailResponse as fR, type SendBuyerPaymentsReceivedEmailRequest as fS, type SendBuyerPaymentsReceivedEmailResponse as fT, type SendBuyerPickupConfirmationEmailRequest as fU, type SendBuyerPickupConfirmationEmailResponse as fV, type BulkSendBuyerPickupConfirmationEmailsRequest as fW, type BulkSendBuyerPickupConfirmationEmailsResponse as fX, type SendBuyerShippingConfirmationEmailRequest as fY, type SendBuyerShippingConfirmationEmailResponse as fZ, type BulkSendBuyerShippingConfirmationEmailsRequest as f_, type RestockInfo as fa, type RestockItem as fb, type OrderTransactions as fc, type Payment as fd, type PaymentPaymentDetailsOneOf as fe, type PaymentReceiptInfoOneOf as ff, type PaymentStatusDetailsOneOf as fg, type RegularPaymentDetails as fh, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fi, type CreditCardPaymentMethodDetails as fj, type AuthorizationDetails as fk, type AuthorizationCapture as fl, type AuthorizationActionFailureDetails as fm, type AuthorizationVoid as fn, type V1ScheduledAction as fo, type Chargeback as fp, type PaymentMethodName as fq, type GiftCardPaymentDetails as fr, type MembershipPaymentDetails as fs, type FutureMembershipDetails as ft, type WixReceiptInfo as fu, type ExternalReceiptInfo as fv, type CashRoundingDetails as fw, type CanceledStatusDetails as fx, type DeclinedStatusDetails as fy, type VoidedStatusDetails as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type AddToAutomationMigrationPopulationRequest as g$, type SendMerchantOrderReceivedNotificationRequest as g0, type SendMerchantOrderReceivedNotificationResponse as g1, type SendCancelRefundEmailRequest as g2, type SendCancelRefundEmailResponse as g3, type SendRefundEmailRequest as g4, type SendRefundEmailResponse as g5, type SendFulfillmentEmailRequest as g6, type SendFulfillmentEmailResponse as g7, type SendMerchantOrderReceivedPushRequest as g8, type SendMerchantOrderReceivedPushResponse as g9, type SitePublished as gA, type SiteUnpublished as gB, type SiteMarkedAsTemplate as gC, type SiteMarkedAsWixSite as gD, type ServiceProvisioned as gE, type ServiceRemoved as gF, type SiteRenamed as gG, type SiteHardDeleted as gH, type NamespaceChanged as gI, type StudioAssigned as gJ, type StudioUnassigned as gK, type SiteUrlChanged as gL, type SitePurgedExternally as gM, type OdeditorAssigned as gN, type OdeditorUnassigned as gO, type PicassoAssigned as gP, type PicassoUnassigned as gQ, type WixelAssigned as gR, type WixelUnassigned as gS, type StudioTwoAssigned as gT, type StudioTwoUnassigned as gU, type UserDomainMediaEnabled as gV, type UserDomainMediaDisabled as gW, type EditorlessAssigned as gX, type EditorlessUnassigned as gY, type HasCustomEmailConfigurationsRequest as gZ, type HasCustomEmailConfigurationsResponse as g_, type PreviewEmailByTypeRequest as ga, type PreviewEmailByTypeResponse as gb, type PreviewRefundEmailRequest as gc, type PreviewRefundEmailResponse as gd, type PreviewCancelEmailRequest as ge, type PreviewCancelEmailResponse as gf, type PreviewCancelRefundEmailRequest as gg, type PreviewCancelRefundEmailResponse as gh, type PreviewBuyerPaymentsReceivedEmailRequest as gi, type PreviewBuyerPaymentsReceivedEmailResponse as gj, type PreviewBuyerConfirmationEmailRequest as gk, type PreviewBuyerConfirmationEmailResponse as gl, type PreviewBuyerPickupConfirmationEmailRequest as gm, type PreviewBuyerPickupConfirmationEmailResponse as gn, type PreviewShippingConfirmationEmailRequest as go, type PreviewShippingConfirmationEmailResponse as gp, type PreviewResendDownloadLinksEmailRequest as gq, type PreviewResendDownloadLinksEmailResponse as gr, type MetaSiteSpecialEvent as gs, type MetaSiteSpecialEventPayloadOneOf as gt, type Asset as gu, type SiteCreated as gv, type SiteTransferred as gw, type SiteDeleted as gx, type DeleteContext as gy, type SiteUndeleted as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type UpdateOrderLineItemsResponse as h$, type AddToAutomationMigrationPopulationResponse as h0, type IsInAutomationMigrationPopulationRequest as h1, type IsInAutomationMigrationPopulationResponse as h2, type DiffmatokyPayload as h3, type ErrorInformation as h4, type GetOrderRequest as h5, type GetOrderResponse as h6, type InternalQueryOrdersRequest as h7, type PlatformQuery as h8, type PlatformQueryPagingMethodOneOf as h9, type V1LineItemDelta as hA, type V1LineItemDeltaDeltaOneOf as hB, type CommitDeltasResponse as hC, type ArchiveOrderRequest as hD, type ArchiveOrderResponse as hE, type BulkArchiveOrdersRequest as hF, type BulkArchiveOrdersResponse as hG, type BulkArchiveOrdersByFilterRequest as hH, type BulkArchiveOrdersByFilterResponse as hI, type UnArchiveOrderRequest as hJ, type UnArchiveOrderResponse as hK, type BulkUnArchiveOrdersRequest as hL, type BulkUnArchiveOrdersResponse as hM, type BulkUnArchiveOrdersByFilterRequest as hN, type BulkUnArchiveOrdersByFilterResponse as hO, type UpdateBuyerInfoRequest as hP, type BuyerInfoUpdate as hQ, type UpdateBuyerInfoResponse as hR, type UpdateBuyerEmailRequest as hS, type UpdateBuyerEmailResponse as hT, type UpdateOrderShippingAddressRequest as hU, type UpdateOrderShippingAddressResponse as hV, type UpdateBillingContactDetailsRequest as hW, type UpdateBillingContactDetailsResponse as hX, type UpdateOrderLineItemRequest as hY, type UpdateOrderLineItemsRequest as hZ, type MaskedOrderLineItem as h_, type Sorting as ha, type PlatformPaging as hb, type CursorPaging as hc, type InternalQueryOrdersResponse as hd, type PlatformPagingMetadata as he, type Cursors as hf, type QueryOrderRequest as hg, type QueryOrderResponse as hh, type SearchOrdersRequest as hi, type CursorSearch as hj, type CursorSearchPagingMethodOneOf as hk, type CursorPagingMetadata as hl, type CreateOrderRequest as hm, type OrderCreationSettings as hn, type OrderCreationSettingsEditableByOneOf as ho, type OrderCreateNotifications as hp, type CreateOrderResponse as hq, type UpdateOrderRequest as hr, type UpdateOrderResponse as hs, type BulkUpdateOrdersRequest as ht, type CommitDeltasRequest as hu, type DraftOrderDiffs as hv, type DraftOrderDiffsShippingUpdateInfoOneOf as hw, type DraftOrderDiffsBuyerUpdateInfoOneOf as hx, type DraftOrderDiffsBillingUpdateInfoOneOf as hy, type DraftOrderDiffsRecipientUpdateInfoOneOf as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type DecrementItemsQuantityResponse as i$, type AddInternalActivityRequest as i0, type InternalActivity as i1, type InternalActivityContentOneOf as i2, type OrderPlaced as i3, type OrderPaid as i4, type OrderFulfilled as i5, type OrderNotFulfilled as i6, type OrderCanceled as i7, type DownloadLinkSent as i8, type TrackingNumberAdded as i9, type UpdateOrderStatusRequest as iA, type MarkAsFulfilledRequest as iB, type MarkAsFulfilledResponse as iC, type BulkMarkAsFulfilledRequest as iD, type BulkMarkAsFulfilledResponse as iE, type BulkMarkAsFulfilledByFilterRequest as iF, type BulkMarkAsFulfilledByFilterResponse as iG, type MarkAsUnfulfilledRequest as iH, type MarkAsUnfulfilledResponse as iI, type BulkMarkAsUnfulfilledRequest as iJ, type BulkMarkAsUnfulfilledResponse as iK, type BulkMarkAsUnfulfilledByFilterRequest as iL, type BulkMarkAsUnfulfilledByFilterResponse as iM, type BulkSetBusinessLocationRequest as iN, type BulkSetBusinessLocationResponse as iO, type BulkSetBusinessLocationResult as iP, type V1MarkOrderAsPaidRequest as iQ, type V1MarkOrderAsPaidResponse as iR, type V1BulkMarkOrdersAsPaidRequest as iS, type V1BulkMarkOrdersAsPaidResponse as iT, type V1CreatePaymentGatewayOrderRequest as iU, type V1CreatePaymentGatewayOrderResponse as iV, type GetShipmentsRequest as iW, type GetShipmentsResponse as iX, type AggregateOrdersRequest as iY, type DecrementItemsQuantityRequest as iZ, type DecrementData as i_, type TrackingNumberEdited as ia, type TrackingLinkAdded as ib, type ShippingConfirmationEmailSent as ic, type InvoiceAdded as id, type InvoiceSent as ie, type FulfillerEmailSent as ig, type ShippingAddressEdited as ih, type EmailEdited as ii, type PickupReadyEmailSent as ij, type OrderPartiallyPaid as ik, type OrderPending as il, type OrderRejected as im, type AddInternalActivityResponse as io, type AddActivityRequest as ip, type PublicActivityContentOneOf as iq, type AddActivitiesRequest as ir, type UpdateActivityRequest as is, type DeleteActivityRequest as it, type UpdateLineItemsDescriptionLinesRequest as iu, type LineItemUpdate as iv, type UpdateLineItemsDescriptionLinesResponse as iw, type MarkOrderAsSeenByHumanRequest as ix, type MarkOrderAsSeenByHumanResponse as iy, type CancelOrderRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type RepriceStatusWithLiterals as j$, type BulkUpdateOrderTagsRequest as j0, type TagsTags as j1, type TagsTagList as j2, type BulkUpdateOrderTagsResult as j3, type SendOrderUpdatedDomainEventRequest as j4, type SendOrderUpdatedDomainEventResponse as j5, type Task as j6, type TaskKey as j7, type TaskAction as j8, type TaskActionActionOneOf as j9, type ItemizedFee as jA, type Discount as jB, type DiscountOneDiscountTypeOneOf as jC, type CalculatedTaxes as jD, type CalculatedTax as jE, type Payments as jF, type InvoicesPayment as jG, type MetaData as jH, type InvoiceDynamicPriceTotals as jI, type CustomFieldValue as jJ, type Value as jK, type Deposit as jL, type BaseEventMetadata as jM, type EventMetadata as jN, type AccountInfoMetadata as jO, type OrderSearchSpec as jP, utils as jQ, type DescriptionLineTypeWithLiterals as jR, type DimensionsUnitWithLiterals as jS, type ItemTypePresetWithLiterals as jT, type PaymentOptionTypeWithLiterals as jU, type JurisdictionTypeWithLiterals as jV, type SubscriptionFrequencyWithLiterals as jW, type ProductPeriodAlignmentWithLiterals as jX, type AdjustmentTypeWithLiterals as jY, type TaxableAddressTypeWithLiterals as jZ, type MeasurementUnitWithLiterals as j_, type Complete as ja, type Cancel as jb, type Reschedule as jc, type InvoiceSentEvent as jd, type IdAndVersion as je, type InvoiceFields as jf, type Customer as jg, type Email as jh, type QuotesAddress as ji, type AddressDescription as jj, type Phone as jk, type Company as jl, type CommonAddress as jm, type CommonAddressStreetOneOf as jn, type Subdivision as jo, type StandardDetails as jp, type ShippingContactDetails as jq, type InvoiceDates as jr, type LineItems as js, type LineItem as jt, type BigDecimalWrapper as ju, type LineItemTax as jv, type Source as jw, type LineItemMetaData as jx, type Locale as jy, type TotalPrice as jz, type GetRefundabilityStatusResponse as k, onOrderCreated as k$, type BaseRateSourceWithLiterals as k0, type PaymentStatusEnumPaymentStatusWithLiterals as k1, type FulfillmentStatusWithLiterals as k2, type WeightUnitWithLiterals as k3, type VatTypeWithLiterals as k4, type PickupMethodWithLiterals as k5, type CrossBorderNotApplicableReasonWithLiterals as k6, type CrossBorderRepricingModeWithLiterals as k7, type DiscountTypeWithLiterals as k8, type DiscountValueTypeWithLiterals as k9, type ActionTypeWithLiterals as kA, type ChargebackStatusWithLiterals as kB, type MembershipPaymentStatusWithLiterals as kC, type PaymentStatusWithLiterals as kD, type CanceledReasonWithLiterals as kE, type DeclinedReasonWithLiterals as kF, type VoidedReasonWithLiterals as kG, type RefundStatusWithLiterals as kH, type PreviewEmailTypeWithLiterals as kI, type StateWithLiterals as kJ, type SiteCreatedContextWithLiterals as kK, type NamespaceWithLiterals as kL, type DeleteStatusWithLiterals as kM, type OriginWithLiterals as kN, type SortOrderWithLiterals as kO, type OrderApprovalStrategyWithLiterals as kP, type PlacementWithLiterals as kQ, type SubdivisionTypeWithLiterals as kR, type SourceTypeWithLiterals as kS, type CustomFieldGroupWithLiterals as kT, type ValueTypeWithLiterals as kU, type DepositTypeWithLiterals as kV, type InvoiceStatusWithLiterals as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type DiscountReasonWithLiterals as ka, type LineItemQuantityChangeTypeWithLiterals as kb, type ActivityTypeWithLiterals as kc, type OrderActivityTypeEnumActivityTypeWithLiterals as kd, type AttributionSourceWithLiterals as ke, type ChannelTypeWithLiterals as kf, type AdditionalFeeSourceWithLiterals as kg, type OrderActionTypeWithLiterals as kh, type SpecificItemsCouponBehaviorWithLiterals as ki, type ChargeTypeWithLiterals as kj, type VersioningModeWithLiterals as kk, type DeltaPaymentOptionTypeWithLiterals as kl, type InventoryActionWithLiterals as km, type WebhookIdentityTypeWithLiterals as kn, type ScheduledActionWithLiterals as ko, type DurationUnitWithLiterals as kp, type PaymentCollectabilityStatusWithLiterals as kq, type PredefinedPaymentMethodWithLiterals as kr, type RefundableStatusWithLiterals as ks, type NonRefundableReasonWithLiterals as kt, type ManuallyRefundableReasonWithLiterals as ku, type RestockTypeWithLiterals as kv, type TransactionStatusWithLiterals as kw, type AuthorizationCaptureStatusWithLiterals as kx, type AuthorizationVoidStatusWithLiterals as ky, type ReasonWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, onOrderFulfilled as l0, onOrderImported as l1, onOrderImportedOrderDeleted as l2, onOrderPaymentStatusUpdated as l3, onOrderUpdated as l4, importOrder as l5, setOrderNumberCounter as l6, bulkDeleteImportedOrders as l7, preparePaymentCollection as l8, getPaymentCollectabilityStatus as l9, recordManuallyCollectedPayment as la, paymentCollectionMarkOrderAsPaid as lb, paymentCollectionBulkMarkOrdersAsPaid as lc, getRefundabilityStatus as ld, paymentCollectionCreatePaymentGatewayOrder as le, chargeMemberships as lf, triggerRefund as lg, voidAuthorizedPayments as lh, captureAuthorizedPayments as li, getOrder as lj, createOrder as lk, updateOrder as ll, bulkUpdateOrders as lm, updateOrderLineItem as ln, addActivity as lo, addActivities as lp, updateActivity as lq, deleteActivity as lr, cancelOrder as ls, updateOrderStatus as lt, aggregateOrders as lu, bulkUpdateOrderTags as lv, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };