@wix/auto_sdk_ecom_orders 1.0.294 → 1.0.296

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-CeSyrIwk.d.ts → ecom-v1-order-orders.universal-DNvjb4f-.d.ts} +1699 -1699
  2. package/build/cjs/index.d.ts +17 -17
  3. package/build/cjs/index.js +80 -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 +80 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1685 -1685
  9. package/build/cjs/meta.js +80 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-CeSyrIwk.d.mts → ecom-v1-order-orders.universal-DNvjb4f-.d.mts} +1699 -1699
  12. package/build/es/index.d.mts +17 -17
  13. package/build/es/index.mjs +80 -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 +80 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1685 -1685
  19. package/build/es/meta.mjs +80 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-DEhqrc38.d.ts → ecom-v1-order-orders.universal-D6jbuB39.d.ts} +1867 -1867
  22. package/build/internal/cjs/index.d.ts +29 -29
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1841 -1841
  25. package/build/internal/es/{ecom-v1-order-orders.universal-DEhqrc38.d.mts → ecom-v1-order-orders.universal-D6jbuB39.d.mts} +1867 -1867
  26. package/build/internal/es/index.d.mts +29 -29
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1841 -1841
  29. package/package.json +2 -2
@@ -3888,163 +3888,458 @@ interface BulkDeleteImportedOrdersResponse {
3888
3888
  */
3889
3889
  jobId?: string;
3890
3890
  }
3891
- interface SendBuyerConfirmationEmailRequest {
3891
+ interface V1TriggerReindexRequest {
3892
3892
  /** @format GUID */
3893
- orderId?: string;
3894
- }
3895
- interface SendBuyerConfirmationEmailResponse {
3896
- }
3897
- interface SendBuyerPaymentsReceivedEmailRequest {
3893
+ metasiteId?: string;
3898
3894
  /**
3899
3895
  * @minLength 1
3900
3896
  * @maxLength 100
3897
+ * @maxSize 100
3901
3898
  */
3902
- orderId?: string;
3899
+ orderIds?: string[];
3903
3900
  }
3904
- interface SendBuyerPaymentsReceivedEmailResponse {
3901
+ interface V1TriggerReindexResponse {
3905
3902
  }
3906
- interface SendBuyerPickupConfirmationEmailRequest {
3903
+ interface V1TriggerReindexOrderRequest {
3904
+ /** @format GUID */
3905
+ metasiteId?: string;
3907
3906
  /**
3908
3907
  * @minLength 1
3909
3908
  * @maxLength 100
3910
3909
  */
3911
3910
  orderId?: string;
3912
3911
  }
3913
- interface SendBuyerPickupConfirmationEmailResponse {
3914
- }
3915
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
3916
- /**
3917
- * IDs of orders to send pickup emails for.
3918
- * @minSize 1
3919
- * @maxSize 300
3920
- */
3921
- orderIds?: string[];
3922
- }
3923
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
3924
- }
3925
- interface SendBuyerShippingConfirmationEmailRequest {
3912
+ interface PreparePaymentCollectionRequest {
3926
3913
  /**
3914
+ * Ecom order ID.
3927
3915
  * @minLength 1
3928
3916
  * @maxLength 100
3929
3917
  */
3930
- orderId?: string;
3931
- }
3932
- interface SendBuyerShippingConfirmationEmailResponse {
3933
- }
3934
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
3918
+ ecomOrderId: string;
3919
+ /** Amount to collect */
3920
+ amount: Price;
3935
3921
  /**
3936
- * IDs of orders to send pickup emails for.
3937
- * @minSize 1
3938
- * @maxSize 300
3922
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
3923
+ * Existing payment gateway order will be updated with a new amount.
3924
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
3939
3925
  */
3940
- orderIds?: string[];
3941
- }
3942
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
3943
- }
3944
- interface SendMerchantOrderReceivedNotificationRequest {
3926
+ paymentGatewayOrderId?: string | null;
3945
3927
  /**
3946
- * @minLength 1
3947
- * @maxLength 100
3928
+ * Whether to delay capture of the payment.
3929
+ * Default: false
3930
+ * @deprecated Whether to delay capture of the payment.
3931
+ * Default: false
3932
+ * @replacedBy delayed_capture_settings.scheduled_action
3933
+ * @targetRemovalDate 2024-09-30
3948
3934
  */
3949
- orderId?: string;
3950
- }
3951
- interface SendMerchantOrderReceivedNotificationResponse {
3935
+ delayedCapture?: boolean;
3936
+ /** Delayed capture payment settings */
3937
+ delayedCaptureSettings?: DelayedCaptureSettings;
3952
3938
  }
3953
- interface SendCancelRefundEmailRequest {
3939
+ interface RedirectUrls {
3954
3940
  /**
3955
- * The ID of order that is canceled/refunded
3956
- * @minLength 1
3957
- * @maxLength 100
3941
+ * URL to redirect buyer in case of approved (successful) transaction
3942
+ * @format WEB_URL
3958
3943
  */
3959
- orderId?: string;
3944
+ successUrl?: string | null;
3960
3945
  /**
3961
- * Personal note added to the email (optional)
3962
- * @minLength 1
3963
- * @maxLength 1000
3946
+ * URL to redirect buyer in case of buyer canceled the transaction
3947
+ * @format WEB_URL
3964
3948
  */
3965
- customMessage?: string | null;
3966
- /** Refund amount */
3967
- refundAmount?: Price;
3949
+ cancelUrl?: string | null;
3968
3950
  /**
3969
- * Refund ID. (Optional)
3970
- * @format GUID
3951
+ * URL to redirect buyer in case of failed/rejected transaction
3952
+ * @format WEB_URL
3971
3953
  */
3972
- refundId?: string | null;
3973
- }
3974
- interface SendCancelRefundEmailResponse {
3975
- }
3976
- interface SendRefundEmailRequest {
3954
+ errorUrl?: string | null;
3977
3955
  /**
3978
- * The ID of order that is refunded
3979
- * @format GUID
3956
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
3957
+ * @format WEB_URL
3980
3958
  */
3981
- orderId?: string;
3959
+ pendingUrl?: string | null;
3960
+ }
3961
+ interface DelayedCaptureSettings {
3962
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
3963
+ scheduledAction?: ScheduledActionWithLiterals;
3964
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
3965
+ delayDuration?: Duration;
3966
+ }
3967
+ declare enum ScheduledAction {
3968
+ /** Whether payment will be auto-voided when duration passes */
3969
+ VOID = "VOID",
3970
+ /** Whether payment will be auto-captured when duration passes */
3971
+ CAPTURE = "CAPTURE"
3972
+ }
3973
+ /** @enumType */
3974
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
3975
+ interface Duration {
3982
3976
  /**
3983
- * Refund ID
3984
- * @format GUID
3977
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
3978
+ * @min 1
3985
3979
  */
3986
- refundId?: string;
3980
+ count?: number;
3981
+ /** Duration unit: MINUTES, HOURS and DAYS */
3982
+ unit?: DurationUnitWithLiterals;
3983
+ }
3984
+ declare enum DurationUnit {
3985
+ MINUTES = "MINUTES",
3986
+ HOURS = "HOURS",
3987
+ DAYS = "DAYS"
3988
+ }
3989
+ /** @enumType */
3990
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
3991
+ interface PreparePaymentCollectionResponse {
3992
+ /** Payment gateway order id which is associated with given payment */
3993
+ paymentGatewayOrderId?: string;
3994
+ }
3995
+ interface GetPaymentCollectabilityStatusRequest {
3987
3996
  /**
3988
- * Personal note added to the email (optional)
3997
+ * Ecom order ID.
3989
3998
  * @minLength 1
3990
- * @maxLength 1000
3999
+ * @maxLength 100
3991
4000
  */
3992
- customMessage?: string | null;
3993
- }
3994
- interface SendRefundEmailResponse {
4001
+ ecomOrderId: string;
3995
4002
  }
3996
- interface SendFulfillmentEmailRequest {
3997
- /** @format GUID */
3998
- orderId?: string;
3999
- /** @format GUID */
4000
- fulfillerId?: string;
4003
+ interface GetPaymentCollectabilityStatusResponse {
4004
+ /** Payment collectability status */
4005
+ status?: PaymentCollectabilityStatusWithLiterals;
4006
+ /** Collectable order amount */
4007
+ amount?: Price;
4001
4008
  }
4002
- interface SendFulfillmentEmailResponse {
4009
+ declare enum PaymentCollectabilityStatus {
4010
+ UNKNOWN = "UNKNOWN",
4011
+ COLLECTABLE = "COLLECTABLE",
4012
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4013
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4014
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4015
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4016
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4017
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4018
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4019
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4020
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4021
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
4003
4022
  }
4004
- interface SendMerchantOrderReceivedPushRequest {
4023
+ /** @enumType */
4024
+ 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';
4025
+ interface RecordManuallyCollectedPaymentRequest {
4005
4026
  /**
4027
+ * Order ID.
4006
4028
  * @minLength 1
4007
4029
  * @maxLength 100
4008
4030
  */
4009
- orderId?: string;
4031
+ orderId: string;
4032
+ /** Amount to be recorded as approved manual payment for given order */
4033
+ amount: Price;
4010
4034
  }
4011
- interface SendMerchantOrderReceivedPushResponse {
4035
+ /**
4036
+ * User-defined payment method name.
4037
+ * Allows specifying either a predefined type or a custom name.
4038
+ */
4039
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4040
+ /** Predefined payment method. */
4041
+ predefined?: PredefinedPaymentMethodWithLiterals;
4042
+ /**
4043
+ * Custom payment method name provided by user.
4044
+ *
4045
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4046
+ * @minLength 1
4047
+ * @maxLength 150
4048
+ */
4049
+ custom?: string | null;
4012
4050
  }
4013
- interface PreviewEmailByTypeRequest {
4014
- emailType?: PreviewEmailTypeWithLiterals;
4051
+ /** @oneof */
4052
+ interface UserDefinedPaymentMethodNameKindOneOf {
4053
+ /** Predefined payment method. */
4054
+ predefined?: PredefinedPaymentMethodWithLiterals;
4055
+ /**
4056
+ * Custom payment method name provided by user.
4057
+ *
4058
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4059
+ * @minLength 1
4060
+ * @maxLength 150
4061
+ */
4062
+ custom?: string | null;
4015
4063
  }
4016
- declare enum PreviewEmailType {
4017
- ORDER_PLACED = "ORDER_PLACED",
4018
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4019
- ORDER_SHIPPED = "ORDER_SHIPPED",
4020
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4064
+ /** Predefined payment method types for offline/manual payments. */
4065
+ declare enum PredefinedPaymentMethod {
4066
+ /** Cash payment. */
4067
+ CASH = "CASH",
4068
+ /** Bank transfer. */
4069
+ BANK_TRANSFER = "BANK_TRANSFER",
4070
+ /** Payment by check. */
4071
+ CHECK = "CHECK"
4021
4072
  }
4022
4073
  /** @enumType */
4023
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4024
- interface PreviewEmailByTypeResponse {
4025
- emailPreview?: string;
4074
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4075
+ interface RecordManuallyCollectedPaymentResponse {
4026
4076
  }
4027
- interface PreviewRefundEmailRequest {
4077
+ interface MarkOrderAsPaidRequest {
4028
4078
  /**
4079
+ * Ecom order ID.
4029
4080
  * @minLength 1
4030
4081
  * @maxLength 100
4031
4082
  */
4032
- orderId?: string;
4033
- /** Refund amount */
4034
- refundAmount?: Price;
4035
- /** Refund business details */
4036
- details?: RefundDetails;
4083
+ ecomOrderId: string;
4084
+ }
4085
+ interface MarkOrderAsPaidResponse {
4086
+ /** Updated order. */
4087
+ order?: Order;
4088
+ }
4089
+ interface BulkMarkOrdersAsPaidRequest {
4037
4090
  /**
4038
- * Personal note added to the email (optional)
4091
+ * IDs of orders to mark as paid.
4092
+ * @minSize 1
4093
+ * @maxSize 100
4039
4094
  * @minLength 1
4040
- * @maxLength 1000
4095
+ * @maxLength 100
4041
4096
  */
4042
- customMessage?: string | null;
4097
+ ecomOrderIds: string[];
4098
+ }
4099
+ interface BulkMarkOrdersAsPaidResponse {
4043
4100
  /**
4044
- * Refund ID. (Optional)
4045
- * @format GUID
4101
+ * Items updated by the bulk action.
4102
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4046
4103
  */
4047
- refundId?: string | null;
4104
+ results?: BulkOrderResult[];
4105
+ /** Bulk action metadata. */
4106
+ bulkActionMetadata?: BulkActionMetadata;
4107
+ }
4108
+ interface BulkOrderResult {
4109
+ /** Item metadata. */
4110
+ itemMetadata?: ItemMetadata;
4111
+ /**
4112
+ * Updated order.
4113
+ *
4114
+ * Returned when `returnFullEntity = true`.
4115
+ */
4116
+ item?: Order;
4117
+ }
4118
+ interface ItemMetadata {
4119
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4120
+ _id?: string | null;
4121
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4122
+ originalIndex?: number;
4123
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4124
+ success?: boolean;
4125
+ /** Details about the error in case of failure. */
4126
+ error?: ApplicationError;
4127
+ }
4128
+ interface ApplicationError {
4129
+ /** Error code. */
4130
+ code?: string;
4131
+ /** Description of the error. */
4132
+ description?: string;
4133
+ /** Data related to the error. */
4134
+ data?: Record<string, any> | null;
4135
+ }
4136
+ interface BulkActionMetadata {
4137
+ /** Number of items that were successfully processed. */
4138
+ totalSuccesses?: number;
4139
+ /** Number of items that couldn't be processed. */
4140
+ totalFailures?: number;
4141
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4142
+ undetailedFailures?: number;
4143
+ }
4144
+ interface GetRefundabilityStatusRequest {
4145
+ /**
4146
+ * Order ID.
4147
+ * @minLength 1
4148
+ * @maxLength 100
4149
+ */
4150
+ ecomOrderId: string;
4151
+ }
4152
+ interface GetRefundabilityStatusResponse {
4153
+ /**
4154
+ * Refundability details.
4155
+ * @maxSize 300
4156
+ */
4157
+ refundabilities?: Refundability[];
4158
+ /**
4159
+ * Whether the order supports refunding per item.
4160
+ * @deprecated
4161
+ */
4162
+ refundablePerItem?: boolean;
4163
+ }
4164
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4165
+ /** Reason why payment is not refundable. */
4166
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4167
+ /** Reason why payment is only refundable manually. */
4168
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4169
+ /** Payment ID. */
4170
+ paymentId?: string;
4171
+ /** Payment refundability status. */
4172
+ refundabilityStatus?: RefundableStatusWithLiterals;
4173
+ /** Link to payment provider dashboard. */
4174
+ providerLink?: string | null;
4175
+ }
4176
+ /** @oneof */
4177
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4178
+ /** Reason why payment is not refundable. */
4179
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4180
+ /** Reason why payment is only refundable manually. */
4181
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4182
+ }
4183
+ declare enum RefundableStatus {
4184
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4185
+ MANUAL = "MANUAL",
4186
+ REFUNDABLE = "REFUNDABLE"
4187
+ }
4188
+ /** @enumType */
4189
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4190
+ declare enum NonRefundableReason {
4191
+ NONE = "NONE",
4192
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4193
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4194
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4195
+ NOT_PAID = "NOT_PAID",
4196
+ ACCESS_DENIED = "ACCESS_DENIED",
4197
+ ZERO_PRICE = "ZERO_PRICE",
4198
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4199
+ PENDING_REFUND = "PENDING_REFUND",
4200
+ FORBIDDEN = "FORBIDDEN",
4201
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4202
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4203
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4204
+ }
4205
+ /** @enumType */
4206
+ 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';
4207
+ declare enum ManuallyRefundableReason {
4208
+ EXPIRED = "EXPIRED",
4209
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4210
+ OFFLINE = "OFFLINE",
4211
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4212
+ }
4213
+ /** @enumType */
4214
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4215
+ interface CreatePaymentGatewayOrderRequest {
4216
+ /**
4217
+ * Ecom order ID.
4218
+ * @minLength 1
4219
+ * @maxLength 100
4220
+ */
4221
+ ecomOrderId: string;
4222
+ /** Information about the user who initiated the payment. */
4223
+ chargedBy?: ChargedBy;
4224
+ }
4225
+ interface ChargedBy {
4226
+ /**
4227
+ * ID - id of the user who initiated the payment
4228
+ * @format GUID
4229
+ */
4230
+ _id?: string;
4231
+ /**
4232
+ * Full name - name of the user who initiated the payment
4233
+ * @minLength 1
4234
+ * @maxLength 200
4235
+ */
4236
+ fullName?: string | null;
4237
+ }
4238
+ interface CreatePaymentGatewayOrderResponse {
4239
+ /** ID of the order created in the payment gateway */
4240
+ paymentGatewayOrderId?: string;
4241
+ }
4242
+ interface ChargeMembershipsRequest {
4243
+ /**
4244
+ * Order ID.
4245
+ * @minLength 1
4246
+ * @maxLength 100
4247
+ */
4248
+ ecomOrderId: string;
4249
+ /**
4250
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4251
+ * but a user which is using the membership on behalf of the a member
4252
+ * @format GUID
4253
+ */
4254
+ memberId: string;
4255
+ /**
4256
+ * List of items to be paid by memberships
4257
+ * @minSize 1
4258
+ * @maxSize 300
4259
+ */
4260
+ membershipCharges?: MembershipChargeItem[];
4261
+ }
4262
+ interface MembershipChargeItem {
4263
+ /**
4264
+ * The id of used membership
4265
+ * @minLength 1
4266
+ * @maxLength 100
4267
+ */
4268
+ membershipId?: string;
4269
+ /**
4270
+ * ID of the application providing this payment option
4271
+ * @format GUID
4272
+ */
4273
+ appId?: string;
4274
+ /** The name of used membership */
4275
+ membershipName?: MembershipName;
4276
+ /** Additional data about this membership */
4277
+ membershipAdditionalData?: Record<string, any> | null;
4278
+ /** Catalog and item reference info. */
4279
+ catalogReference?: CatalogReference;
4280
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
4281
+ serviceProperties?: ServiceProperties;
4282
+ /**
4283
+ * Usually would be the same as catalogReference.catalogItemId
4284
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
4285
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4286
+ * @minLength 1
4287
+ * @maxLength 36
4288
+ */
4289
+ rootCatalogItemId?: string | null;
4290
+ /**
4291
+ * line item id of Checkout/Order line item
4292
+ * @minLength 1
4293
+ * @maxLength 100
4294
+ */
4295
+ lineItemId?: string;
4296
+ }
4297
+ interface MembershipName {
4298
+ /**
4299
+ * Membership name.
4300
+ * @maxLength 100
4301
+ */
4302
+ original?: string;
4303
+ /**
4304
+ * Translated membership name. Defaults to `original` when not provided.
4305
+ * @maxLength 100
4306
+ */
4307
+ translated?: string | null;
4308
+ }
4309
+ interface ChargeMembershipsResponse {
4310
+ }
4311
+ interface TriggerRefundRequest {
4312
+ /**
4313
+ * The order this refund related to
4314
+ * @minLength 1
4315
+ * @maxLength 100
4316
+ */
4317
+ ecomOrderId: string;
4318
+ /**
4319
+ * Refund operations information
4320
+ * @minSize 1
4321
+ * @maxSize 1
4322
+ */
4323
+ payments: PaymentRefund[];
4324
+ /** Business model of a refund */
4325
+ details?: RefundDetails;
4326
+ /** Side effect details related to refund */
4327
+ sideEffects?: RefundSideEffects;
4328
+ }
4329
+ interface PaymentRefund {
4330
+ /**
4331
+ * Specific payment within the order to refund
4332
+ * @format GUID
4333
+ */
4334
+ paymentId?: string;
4335
+ /** Refund amount. Not relevant for membership and gift card refunds. */
4336
+ amount?: Price;
4337
+ /**
4338
+ * Whether refund is made externally and manually (on the payment provider's side)
4339
+ * 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.
4340
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4341
+ */
4342
+ externalRefund?: boolean;
4048
4343
  }
4049
4344
  /** Business model of a refund request */
4050
4345
  interface RefundDetails {
@@ -4121,1938 +4416,1643 @@ interface ShippingRefund {
4121
4416
  */
4122
4417
  amount?: Price;
4123
4418
  }
4124
- interface PreviewRefundEmailResponse {
4125
- emailPreview?: string;
4126
- }
4127
- interface PreviewCancelEmailRequest {
4128
- /**
4129
- * @minLength 1
4130
- * @maxLength 100
4131
- */
4132
- orderId?: string;
4419
+ interface RefundSideEffects {
4420
+ /** Inventory restock details as part of this refund. */
4421
+ restockInfo?: RestockInfo;
4422
+ /** Whether to send a refund confirmation email to the customer. */
4423
+ sendOrderRefundedEmail?: boolean;
4133
4424
  /**
4134
- * Personal note added to the email (optional)
4425
+ * Custom message added to the refund confirmation email.
4135
4426
  * @minLength 1
4136
4427
  * @maxLength 1000
4137
4428
  */
4138
4429
  customMessage?: string | null;
4139
4430
  }
4140
- interface PreviewCancelEmailResponse {
4141
- emailPreview?: string;
4142
- }
4143
- interface PreviewCancelRefundEmailRequest {
4144
- /**
4145
- * @minLength 1
4146
- * @maxLength 100
4147
- */
4148
- orderId?: string;
4149
- /**
4150
- * Personal note added to the email (optional)
4151
- * @minLength 1
4152
- * @maxLength 1000
4153
- */
4154
- customMessage?: string | null;
4155
- /** Refund amount */
4156
- refundAmount?: Price;
4157
- /**
4158
- * Refund ID. (Optional)
4159
- * @format GUID
4160
- */
4161
- refundId?: string | null;
4162
- }
4163
- interface PreviewCancelRefundEmailResponse {
4164
- emailPreview?: string;
4165
- }
4166
- interface PreviewBuyerPaymentsReceivedEmailRequest {
4167
- }
4168
- interface PreviewBuyerPaymentsReceivedEmailResponse {
4169
- emailPreview?: string;
4170
- }
4171
- interface PreviewBuyerConfirmationEmailRequest {
4172
- }
4173
- interface PreviewBuyerConfirmationEmailResponse {
4174
- emailPreview?: string;
4175
- }
4176
- interface PreviewBuyerPickupConfirmationEmailRequest {
4177
- }
4178
- interface PreviewBuyerPickupConfirmationEmailResponse {
4179
- emailPreview?: string;
4180
- }
4181
- interface PreviewShippingConfirmationEmailRequest {
4182
- }
4183
- interface PreviewShippingConfirmationEmailResponse {
4184
- emailPreview?: string;
4185
- }
4186
- interface PreviewResendDownloadLinksEmailRequest {
4187
- }
4188
- interface PreviewResendDownloadLinksEmailResponse {
4189
- emailPreview?: string;
4190
- }
4191
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4192
- /** Emitted on a meta site creation. */
4193
- siteCreated?: SiteCreated;
4194
- /** Emitted on a meta site transfer completion. */
4195
- siteTransferred?: SiteTransferred;
4196
- /** Emitted on a meta site deletion. */
4197
- siteDeleted?: SiteDeleted;
4198
- /** Emitted on a meta site restoration. */
4199
- siteUndeleted?: SiteUndeleted;
4200
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4201
- sitePublished?: SitePublished;
4202
- /** Emitted on a meta site unpublish. */
4203
- siteUnpublished?: SiteUnpublished;
4204
- /** Emitted when meta site is marked as template. */
4205
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4206
- /** Emitted when meta site is marked as a WixSite. */
4207
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4208
- /** Emitted when an application is provisioned (installed). */
4209
- serviceProvisioned?: ServiceProvisioned;
4210
- /** Emitted when an application is removed (uninstalled). */
4211
- serviceRemoved?: ServiceRemoved;
4212
- /** Emitted when meta site name (URL slug) is changed. */
4213
- siteRenamedPayload?: SiteRenamed;
4214
- /** Emitted when meta site was permanently deleted. */
4215
- hardDeleted?: SiteHardDeleted;
4216
- /** Emitted on a namespace change. */
4217
- namespaceChanged?: NamespaceChanged;
4218
- /** Emitted when Studio is attached. */
4219
- studioAssigned?: StudioAssigned;
4220
- /** Emitted when Studio is detached. */
4221
- studioUnassigned?: StudioUnassigned;
4222
- /**
4223
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4224
- * the actual URL.
4225
- *
4226
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4227
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4228
- */
4229
- urlChanged?: SiteUrlChanged;
4230
- /** Site is marked as PurgedExternally */
4231
- sitePurgedExternally?: SitePurgedExternally;
4232
- /** Emitted when Odeditor is attached. */
4233
- odeditorAssigned?: OdeditorAssigned;
4234
- /** Emitted when Odeditor is detached. */
4235
- odeditorUnassigned?: OdeditorUnassigned;
4236
- /** Emitted when Picasso is attached. */
4237
- picassoAssigned?: PicassoAssigned;
4238
- /** Emitted when Picasso is detached. */
4239
- picassoUnassigned?: PicassoUnassigned;
4240
- /** Emitted when Wixel is attached. */
4241
- wixelAssigned?: WixelAssigned;
4242
- /** Emitted when Wixel is detached. */
4243
- wixelUnassigned?: WixelUnassigned;
4244
- /** Emitted when StudioTwo is attached. */
4245
- studioTwoAssigned?: StudioTwoAssigned;
4246
- /** Emitted when StudioTwo is detached. */
4247
- studioTwoUnassigned?: StudioTwoUnassigned;
4248
- /** Emitted when media from user domain is enabled. */
4249
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4250
- /** Emitted when media from user domain is disabled. */
4251
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4252
- /** Emitted when Editorless is attached. */
4253
- editorlessAssigned?: EditorlessAssigned;
4254
- /** Emitted when Editorless is detached. */
4255
- editorlessUnassigned?: EditorlessUnassigned;
4256
- /**
4257
- * A meta site id.
4258
- * @format GUID
4259
- */
4260
- metaSiteId?: string;
4261
- /** A meta site version. Monotonically increasing. */
4262
- version?: string;
4263
- /** A timestamp of the event. */
4264
- timestamp?: string;
4265
- /**
4266
- * TODO(meta-site): Change validation once validations are disabled for consumers
4267
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4268
- * @maxSize 4000
4269
- */
4270
- assets?: Asset[];
4271
- }
4272
- /** @oneof */
4273
- interface MetaSiteSpecialEventPayloadOneOf {
4274
- /** Emitted on a meta site creation. */
4275
- siteCreated?: SiteCreated;
4276
- /** Emitted on a meta site transfer completion. */
4277
- siteTransferred?: SiteTransferred;
4278
- /** Emitted on a meta site deletion. */
4279
- siteDeleted?: SiteDeleted;
4280
- /** Emitted on a meta site restoration. */
4281
- siteUndeleted?: SiteUndeleted;
4282
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4283
- sitePublished?: SitePublished;
4284
- /** Emitted on a meta site unpublish. */
4285
- siteUnpublished?: SiteUnpublished;
4286
- /** Emitted when meta site is marked as template. */
4287
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4288
- /** Emitted when meta site is marked as a WixSite. */
4289
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4290
- /** Emitted when an application is provisioned (installed). */
4291
- serviceProvisioned?: ServiceProvisioned;
4292
- /** Emitted when an application is removed (uninstalled). */
4293
- serviceRemoved?: ServiceRemoved;
4294
- /** Emitted when meta site name (URL slug) is changed. */
4295
- siteRenamedPayload?: SiteRenamed;
4296
- /** Emitted when meta site was permanently deleted. */
4297
- hardDeleted?: SiteHardDeleted;
4298
- /** Emitted on a namespace change. */
4299
- namespaceChanged?: NamespaceChanged;
4300
- /** Emitted when Studio is attached. */
4301
- studioAssigned?: StudioAssigned;
4302
- /** Emitted when Studio is detached. */
4303
- studioUnassigned?: StudioUnassigned;
4304
- /**
4305
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4306
- * the actual URL.
4307
- *
4308
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4309
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4310
- */
4311
- urlChanged?: SiteUrlChanged;
4312
- /** Site is marked as PurgedExternally */
4313
- sitePurgedExternally?: SitePurgedExternally;
4314
- /** Emitted when Odeditor is attached. */
4315
- odeditorAssigned?: OdeditorAssigned;
4316
- /** Emitted when Odeditor is detached. */
4317
- odeditorUnassigned?: OdeditorUnassigned;
4318
- /** Emitted when Picasso is attached. */
4319
- picassoAssigned?: PicassoAssigned;
4320
- /** Emitted when Picasso is detached. */
4321
- picassoUnassigned?: PicassoUnassigned;
4322
- /** Emitted when Wixel is attached. */
4323
- wixelAssigned?: WixelAssigned;
4324
- /** Emitted when Wixel is detached. */
4325
- wixelUnassigned?: WixelUnassigned;
4326
- /** Emitted when StudioTwo is attached. */
4327
- studioTwoAssigned?: StudioTwoAssigned;
4328
- /** Emitted when StudioTwo is detached. */
4329
- studioTwoUnassigned?: StudioTwoUnassigned;
4330
- /** Emitted when media from user domain is enabled. */
4331
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4332
- /** Emitted when media from user domain is disabled. */
4333
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4334
- /** Emitted when Editorless is attached. */
4335
- editorlessAssigned?: EditorlessAssigned;
4336
- /** Emitted when Editorless is detached. */
4337
- editorlessUnassigned?: EditorlessUnassigned;
4338
- }
4339
- interface Asset {
4340
- /**
4341
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4342
- * @maxLength 36
4343
- */
4344
- appDefId?: string;
4345
- /**
4346
- * An instance id. For legacy reasons may be UUID or a string.
4347
- * @maxLength 200
4348
- */
4349
- instanceId?: string;
4350
- /** An application state. */
4351
- state?: StateWithLiterals;
4352
- }
4353
- declare enum State {
4354
- UNKNOWN = "UNKNOWN",
4355
- ENABLED = "ENABLED",
4356
- DISABLED = "DISABLED",
4357
- PENDING = "PENDING",
4358
- DEMO = "DEMO"
4359
- }
4360
- /** @enumType */
4361
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4362
- interface SiteCreated {
4363
- /**
4364
- * A template identifier (empty if not created from a template).
4365
- * @maxLength 36
4366
- */
4367
- originTemplateId?: string;
4368
- /**
4369
- * An account id of the owner.
4370
- * @format GUID
4371
- */
4372
- ownerId?: string;
4373
- /** A context in which meta site was created. */
4374
- context?: SiteCreatedContextWithLiterals;
4375
- /**
4376
- * A meta site id from which this site was created.
4377
- *
4378
- * In case of a creation from a template it's a template id.
4379
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4380
- * @format GUID
4381
- */
4382
- originMetaSiteId?: string | null;
4383
- /**
4384
- * A meta site name (URL slug).
4385
- * @maxLength 20
4386
- */
4387
- siteName?: string;
4388
- /** A namespace. */
4389
- namespace?: NamespaceWithLiterals;
4390
- }
4391
- declare enum SiteCreatedContext {
4392
- /** A valid option, we don't expose all reasons why site might be created. */
4393
- OTHER = "OTHER",
4394
- /** A meta site was created from template. */
4395
- FROM_TEMPLATE = "FROM_TEMPLATE",
4396
- /** A meta site was created by copying of the transfferred meta site. */
4397
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4398
- /** A copy of existing meta site. */
4399
- DUPLICATE = "DUPLICATE",
4400
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4401
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4402
- /** deprecated A meta site was created for Flash editor. */
4403
- FLASH = "FLASH"
4404
- }
4405
- /** @enumType */
4406
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4407
- declare enum Namespace {
4408
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4409
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4410
- WIX = "WIX",
4411
- /** 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. */
4412
- SHOUT_OUT = "SHOUT_OUT",
4413
- /** 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. */
4414
- ALBUMS = "ALBUMS",
4415
- /** 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. */
4416
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4417
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4418
- HOTELS = "HOTELS",
4419
- /** 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. */
4420
- CLUBS = "CLUBS",
4421
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4422
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4423
- /**
4424
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4425
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4426
- */
4427
- DEV_SITE = "DEV_SITE",
4428
- /** 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. */
4429
- LOGOS = "LOGOS",
4430
- /** 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. */
4431
- VIDEO_MAKER = "VIDEO_MAKER",
4432
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4433
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4434
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4435
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4431
+ interface RestockInfo {
4432
+ /** Restock type. */
4433
+ type?: RestockTypeWithLiterals;
4436
4434
  /**
4437
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4438
- *
4439
- * Meta site with this namespace will *not* be shown in a user's site list by default.
4435
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4436
+ * @maxSize 300
4440
4437
  */
4441
- HTML_DRAFT = "HTML_DRAFT",
4438
+ items?: RestockItem[];
4439
+ }
4440
+ declare enum RestockType {
4441
+ NO_ITEMS = "NO_ITEMS",
4442
+ ALL_ITEMS = "ALL_ITEMS",
4443
+ SOME_ITEMS = "SOME_ITEMS"
4444
+ }
4445
+ /** @enumType */
4446
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4447
+ interface RestockItem {
4442
4448
  /**
4443
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4444
- * Will be accessible from Site List and will not have a website app.
4445
- * Once the user attaches a site, the site will become a regular wixsite.
4449
+ * ID of the line item being restocked.
4450
+ * @format GUID
4446
4451
  */
4447
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
4448
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4449
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
4450
- /** It is to be used in the Business First efforts. */
4451
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
4452
- /** Bookings business flow with no site. */
4453
- ANYWHERE = "ANYWHERE",
4454
- /** Namespace for Headless Backoffice with no editor */
4455
- HEADLESS = "HEADLESS",
4452
+ lineItemId?: string;
4456
4453
  /**
4457
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4458
- * The site will be used for account level CSM feature for enterprise
4454
+ * Line item quantity being restocked.
4455
+ * @min 1
4456
+ * @max 100000
4459
4457
  */
4460
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4461
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4462
- RISE = "RISE",
4458
+ quantity?: number;
4459
+ }
4460
+ interface TriggerRefundResponse {
4461
+ /** All order's transactions after the refunds were added */
4462
+ orderTransactions?: OrderTransactions;
4463
+ /** Created refund ID */
4464
+ refundId?: string | null;
4465
+ /** Payment ID's that the refund execution had failed for */
4466
+ failedPaymentIds?: ItemMetadata[];
4467
+ }
4468
+ /**
4469
+ * A record of all payments and refunds associated with an order.
4470
+ *
4471
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4472
+ */
4473
+ interface OrderTransactions {
4463
4474
  /**
4464
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4465
- * There's a blank site behind the scene but it's blank).
4466
- * The Mobile company will be the owner of this namespace.
4475
+ * Order ID.
4476
+ * @format GUID
4467
4477
  */
4468
- BRANDED_FIRST = "BRANDED_FIRST",
4469
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4470
- NOWNIA = "NOWNIA",
4478
+ orderId?: string;
4471
4479
  /**
4472
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
4473
- * The Partners company owns this namespace.
4480
+ * Record of payments made to the merchant.
4481
+ * @maxSize 100
4474
4482
  */
4475
- UGC_TEMPLATE = "UGC_TEMPLATE",
4476
- /** Codux Headless Sites */
4477
- CODUX = "CODUX",
4478
- /** Bobb - AI Design Creator. */
4479
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4483
+ payments?: Payment[];
4480
4484
  /**
4481
- * Shared Blog Site is a unique single site across Enterprise account,
4482
- * This site will hold all Blog posts related to the Marketing product.
4485
+ * Record of refunds made to the buyer.
4486
+ * @maxSize 300
4483
4487
  */
4484
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4485
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4486
- STANDALONE_FORMS = "STANDALONE_FORMS",
4487
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4488
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
4489
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4490
- MIMIR = "MIMIR",
4491
- /** Wix Twins platform. */
4492
- TWINS = "TWINS",
4493
- /** Wix Nano. */
4494
- NANO = "NANO",
4495
- /** Base44 headless sites. */
4496
- BASE44 = "BASE44",
4497
- /** Wix Channels Sites */
4498
- CHANNELS = "CHANNELS",
4499
- /** Nautilus platform. */
4500
- NAUTILUS = "NAUTILUS",
4488
+ refunds?: Refund[];
4489
+ }
4490
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4491
+ /** Regular payment details. */
4492
+ regularPaymentDetails?: RegularPaymentDetails;
4493
+ /** Gift card payment details. */
4494
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4495
+ /** Membership payment details. */
4496
+ membershipPaymentDetails?: MembershipPaymentDetails;
4501
4497
  /**
4502
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4503
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4498
+ * Payment ID.
4499
+ * @format GUID
4500
+ * @readonly
4504
4501
  */
4505
- SYMPHONY = "SYMPHONY",
4506
- /** Nautilus platform app. */
4507
- NAUTILUS_APPS = "NAUTILUS_APPS",
4502
+ _id?: string | null;
4503
+ /** 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. */
4504
+ _createdDate?: Date | null;
4508
4505
  /**
4509
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
4510
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
4506
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4507
+ * @readonly
4511
4508
  */
4512
- VIBU = "VIBU",
4509
+ _updatedDate?: Date | null;
4510
+ /** Payment amount. */
4511
+ amount?: Price;
4513
4512
  /**
4514
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
4515
- * (an Enterprise account may have several), holding that BrandKit's brand definition
4516
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
4517
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
4513
+ * Whether refunds for this payment are disabled.
4514
+ * + `true`: This payment is not refundable.
4515
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4518
4516
  */
4519
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4517
+ refundDisabled?: boolean;
4520
4518
  /**
4521
- * Dev-center development sites (com.wixpress.devcenter.dsm).
4522
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
4519
+ * Whether receipt generation is allowed for this payment.
4520
+ * + `true`: This payment supports receipt generation.
4521
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4522
+ * @readonly
4523
4523
  */
4524
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
4525
- }
4526
- /** @enumType */
4527
- 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';
4528
- /** Site transferred to another user. */
4529
- interface SiteTransferred {
4524
+ supportReceiptGeneration?: boolean;
4525
+ /** Details about cash rounding applied to this payment, when relevant. */
4526
+ cashRounding?: CashRoundingDetails;
4530
4527
  /**
4531
- * A previous owner id (user that transfers meta site).
4532
- * @format GUID
4528
+ * Overall payment status.
4529
+ *
4530
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
4533
4531
  */
4534
- oldOwnerId?: string;
4532
+ status?: PaymentStatusWithLiterals;
4535
4533
  /**
4536
- * A new owner id (user that accepts meta site).
4534
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4537
4535
  * @format GUID
4538
4536
  */
4539
- newOwnerId?: string;
4540
- }
4541
- /** Soft deletion of the meta site. Could be restored. */
4542
- interface SiteDeleted {
4543
- /** A deletion context. */
4544
- deleteContext?: DeleteContext;
4545
- }
4546
- interface DeleteContext {
4547
- /** When the meta site was deleted. */
4548
- dateDeleted?: Date | null;
4549
- /** A status. */
4550
- deleteStatus?: DeleteStatusWithLiterals;
4551
- /**
4552
- * A reason (flow).
4553
- * @maxLength 255
4554
- */
4555
- deleteOrigin?: string;
4556
- /**
4557
- * A service that deleted it.
4558
- * @maxLength 255
4559
- */
4560
- initiatorId?: string | null;
4537
+ chargeCorrelationId?: string | null;
4561
4538
  }
4562
- declare enum DeleteStatus {
4563
- UNKNOWN = "UNKNOWN",
4564
- TRASH = "TRASH",
4565
- DELETED = "DELETED",
4566
- PENDING_PURGE = "PENDING_PURGE",
4567
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4539
+ /** @oneof */
4540
+ interface PaymentPaymentDetailsOneOf {
4541
+ /** Regular payment details. */
4542
+ regularPaymentDetails?: RegularPaymentDetails;
4543
+ /** Gift card payment details. */
4544
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4545
+ /** Membership payment details. */
4546
+ membershipPaymentDetails?: MembershipPaymentDetails;
4568
4547
  }
4569
- /** @enumType */
4570
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4571
- /** Restoration of the meta site. */
4572
- interface SiteUndeleted {
4548
+ /** @oneof */
4549
+ interface PaymentReceiptInfoOneOf {
4573
4550
  }
4574
- /** First publish of a meta site. Or subsequent publish after unpublish. */
4575
- interface SitePublished {
4551
+ /** @oneof */
4552
+ interface PaymentStatusDetailsOneOf {
4576
4553
  }
4577
- interface SiteUnpublished {
4554
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4555
+ /** Credit card details. */
4556
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4578
4557
  /**
4579
- * A list of URLs previously associated with the meta site.
4580
- * @maxLength 4000
4581
- * @maxSize 10000
4558
+ * Wix Payments order ID.
4559
+ * @maxLength 100
4582
4560
  */
4583
- urls?: string[];
4584
- }
4585
- interface SiteMarkedAsTemplate {
4586
- }
4587
- interface SiteMarkedAsWixSite {
4588
- }
4589
- /**
4590
- * Represents a service provisioned a site.
4591
- *
4592
- * Note on `origin_instance_id`:
4593
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4594
- * This is because of the following scenario:
4595
- *
4596
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
4597
- * such as a product catalog. When you create a site from this template, you inherit this
4598
- * default product catalog. However, if the template's product catalog is modified,
4599
- * your site will retain the catalog as it was at the time of site creation. This ensures that
4600
- * your site remains consistent with what you initially received and does not include any
4601
- * changes made to the original template afterward.
4602
- * To ensure this, the TPA on the template gets a new instance_id.
4603
- */
4604
- interface ServiceProvisioned {
4561
+ paymentOrderId?: string | null;
4605
4562
  /**
4606
- * Either UUID or EmbeddedServiceType.
4607
- * @maxLength 36
4563
+ * Payment gateway's transaction ID.
4564
+ * This field is only returned when the value of `offline_payment` is `false`.
4565
+ * @maxLength 100
4566
+ */
4567
+ gatewayTransactionId?: string | null;
4568
+ /**
4569
+ * Payment method.
4570
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4571
+ * Non-exhaustive list of supported values:
4572
+ * + `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`
4573
+ * @maxLength 150
4574
+ * @deprecated Payment method.
4575
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4576
+ * Non-exhaustive list of supported values:
4577
+ * + `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`
4578
+ * @replacedBy payment_method_name
4579
+ * @targetRemovalDate 2026-07-01
4608
4580
  */
4609
- appDefId?: string;
4581
+ paymentMethod?: string | null;
4610
4582
  /**
4611
- * Not only UUID. Something here could be something weird.
4612
- * @maxLength 36
4583
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4584
+ * @maxLength 100
4613
4585
  */
4614
- instanceId?: string;
4586
+ providerTransactionId?: string | null;
4587
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4588
+ offlinePayment?: boolean;
4615
4589
  /**
4616
- * An instance id from which this instance is originated.
4617
- * @maxLength 36
4590
+ * Payment status.
4591
+ * @deprecated Payment status.
4592
+ * @replacedBy payment.status
4593
+ * @targetRemovalDate 2026-11-01
4618
4594
  */
4619
- originInstanceId?: string;
4595
+ status?: TransactionStatusWithLiterals;
4596
+ /** Whether there is a payment agreement that allows for future charges. */
4597
+ savedPaymentMethod?: boolean;
4598
+ /** Authorization details. */
4599
+ authorizationDetails?: AuthorizationDetails;
4620
4600
  /**
4621
- * A version.
4622
- * @maxLength 500
4601
+ * Record of chargebacks made by the buyer.
4602
+ * @maxSize 6
4623
4603
  */
4624
- version?: string | null;
4604
+ chargebacks?: Chargeback[];
4605
+ /** Platform fee amount associated with this payment. */
4606
+ platformFee?: Price;
4625
4607
  /**
4626
- * The origin meta site id
4627
- * @format GUID
4608
+ * Payment method with buyer and optional owner translations.
4609
+ * Non-exhaustive list of supported values:
4610
+ * + `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`
4628
4611
  */
4629
- originMetaSiteId?: string | null;
4612
+ paymentMethodName?: PaymentMethodName;
4630
4613
  }
4631
- interface ServiceRemoved {
4632
- /**
4633
- * Either UUID or EmbeddedServiceType.
4634
- * @maxLength 36
4635
- */
4636
- appDefId?: string;
4614
+ /** @oneof */
4615
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4616
+ /** Credit card details. */
4617
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4618
+ }
4619
+ declare enum TransactionStatus {
4620
+ UNDEFINED = "UNDEFINED",
4621
+ APPROVED = "APPROVED",
4622
+ PENDING = "PENDING",
4623
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4624
+ CANCELED = "CANCELED",
4625
+ DECLINED = "DECLINED",
4626
+ REFUNDED = "REFUNDED",
4627
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4628
+ AUTHORIZED = "AUTHORIZED",
4629
+ VOIDED = "VOIDED"
4630
+ }
4631
+ /** @enumType */
4632
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4633
+ interface CreditCardPaymentMethodDetails {
4637
4634
  /**
4638
- * Not only UUID. Something here could be something weird.
4639
- * @maxLength 36
4635
+ * The last 4 digits of the card number.
4636
+ * @maxLength 4
4640
4637
  */
4641
- instanceId?: string;
4638
+ lastFourDigits?: string | null;
4642
4639
  /**
4643
- * A version.
4644
- * @maxLength 500
4640
+ * Card issuer's brand.
4641
+ * @maxLength 100
4645
4642
  */
4646
- version?: string | null;
4643
+ brand?: string | null;
4647
4644
  }
4648
- /** Rename of the site. Meaning, free public url has been changed as well. */
4649
- interface SiteRenamed {
4645
+ interface AuthorizationDetails {
4650
4646
  /**
4651
- * A new meta site name (URL slug).
4652
- * @maxLength 20
4647
+ * Whether the authorized payment is of a delayed capture.
4648
+ * @readonly
4653
4649
  */
4654
- newSiteName?: string;
4650
+ delayedCapture?: boolean;
4651
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4652
+ authorizedDate?: Date | null;
4655
4653
  /**
4656
- * A previous meta site name (URL slug).
4657
- * @maxLength 255
4654
+ * List of captures associated with payment
4655
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4656
+ * @maxSize 1
4658
4657
  */
4659
- oldSiteName?: string;
4660
- }
4661
- /**
4662
- * Hard deletion of the meta site.
4663
- *
4664
- * Could not be restored. Therefore it's desirable to cleanup data.
4665
- */
4666
- interface SiteHardDeleted {
4667
- /** A deletion context. */
4668
- deleteContext?: DeleteContext;
4669
- }
4670
- interface NamespaceChanged {
4671
- /** A previous namespace. */
4672
- oldNamespace?: NamespaceWithLiterals;
4673
- /** A new namespace. */
4674
- newNamespace?: NamespaceWithLiterals;
4675
- }
4676
- /** Assigned Studio editor */
4677
- interface StudioAssigned {
4678
- }
4679
- /** Unassigned Studio editor */
4680
- interface StudioUnassigned {
4681
- }
4682
- /**
4683
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4684
- *
4685
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4686
- * with sites and its urls, you need to listen to another topic/event. Read about it:
4687
- *
4688
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4689
- */
4690
- interface SiteUrlChanged {
4658
+ captures?: AuthorizationCapture[];
4659
+ /** Void associated with payment */
4660
+ void?: AuthorizationVoid;
4661
+ /** Scheduled action for this transaction */
4662
+ scheduledAction?: V1ScheduledAction;
4691
4663
  }
4692
- /**
4693
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4694
- * Consumed by other teams to remove relevant data.
4695
- */
4696
- interface SitePurgedExternally {
4664
+ interface AuthorizationCapture {
4697
4665
  /**
4698
- * @maxLength 2048
4699
- * @maxSize 100
4700
- * @deprecated
4701
- * @targetRemovalDate 2025-04-15
4666
+ * Capture ID.
4667
+ * @format GUID
4668
+ * @readonly
4702
4669
  */
4703
- appDefId?: string[];
4704
- }
4705
- /** Assigned Odeditor */
4706
- interface OdeditorAssigned {
4707
- }
4708
- /** Unassigned Odeditor */
4709
- interface OdeditorUnassigned {
4710
- }
4711
- /** Assigned Picasso editor */
4712
- interface PicassoAssigned {
4713
- }
4714
- /** Unassigned Picasso */
4715
- interface PicassoUnassigned {
4716
- }
4717
- /** Assigned Wixel */
4718
- interface WixelAssigned {
4719
- }
4720
- /** Unassigned Wixel */
4721
- interface WixelUnassigned {
4722
- }
4723
- /** Assigned StudioTwo */
4724
- interface StudioTwoAssigned {
4725
- }
4726
- /** Unassigned StudioTwo */
4727
- interface StudioTwoUnassigned {
4728
- }
4729
- /** Media from user domain is enabled. */
4730
- interface UserDomainMediaEnabled {
4731
- }
4732
- /** Media from user domain is disabled. */
4733
- interface UserDomainMediaDisabled {
4734
- }
4735
- /** Assigned Editorless */
4736
- interface EditorlessAssigned {
4737
- }
4738
- /** Unassigned Editorless */
4739
- interface EditorlessUnassigned {
4740
- }
4741
- interface HasCustomEmailConfigurationsRequest {
4742
- }
4743
- interface HasCustomEmailConfigurationsResponse {
4744
- hasCustomConfigurations?: boolean;
4745
- }
4746
- interface AddToAutomationMigrationPopulationRequest {
4747
- /** When true, sends custom email configurations to automation system via email */
4748
- sendCustomEmailConfigs?: boolean;
4749
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4750
- origin?: OriginWithLiterals;
4670
+ _id?: string | null;
4671
+ /** Status of this capture action */
4672
+ status?: AuthorizationCaptureStatusWithLiterals;
4673
+ /**
4674
+ * Amount of this capture
4675
+ * @immutable
4676
+ */
4677
+ amount?: Price;
4678
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4679
+ _createdDate?: Date | null;
4680
+ /** In case of status is FAILED may contain failure details */
4681
+ failureDetails?: AuthorizationActionFailureDetails;
4751
4682
  }
4752
- declare enum Origin {
4753
- OPT_IN = "OPT_IN",
4754
- MIGRATION = "MIGRATION"
4683
+ declare enum AuthorizationCaptureStatus {
4684
+ /** Capture operation still in progress. */
4685
+ PENDING = "PENDING",
4686
+ /** Capture operation succeeded. */
4687
+ SUCCEEDED = "SUCCEEDED",
4688
+ /** Capture operation failed. */
4689
+ FAILED = "FAILED"
4755
4690
  }
4756
4691
  /** @enumType */
4757
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4758
- interface AddToAutomationMigrationPopulationResponse {
4759
- success?: boolean;
4760
- }
4761
- interface IsInAutomationMigrationPopulationRequest {
4762
- }
4763
- interface IsInAutomationMigrationPopulationResponse {
4764
- inPopulation?: boolean;
4692
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4693
+ interface AuthorizationActionFailureDetails {
4694
+ /** @maxLength 100 */
4695
+ failureCode?: string;
4765
4696
  }
4766
- interface PreparePaymentCollectionRequest {
4767
- /**
4768
- * Ecom order ID.
4769
- * @minLength 1
4770
- * @maxLength 100
4771
- */
4772
- ecomOrderId: string;
4773
- /** Amount to collect */
4774
- amount: Price;
4775
- /**
4776
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4777
- * Existing payment gateway order will be updated with a new amount.
4778
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4779
- */
4780
- paymentGatewayOrderId?: string | null;
4781
- /**
4782
- * Whether to delay capture of the payment.
4783
- * Default: false
4784
- * @deprecated Whether to delay capture of the payment.
4785
- * Default: false
4786
- * @replacedBy delayed_capture_settings.scheduled_action
4787
- * @targetRemovalDate 2024-09-30
4788
- */
4789
- delayedCapture?: boolean;
4790
- /** Delayed capture payment settings */
4791
- delayedCaptureSettings?: DelayedCaptureSettings;
4697
+ interface AuthorizationVoid {
4698
+ /** Status of this void action */
4699
+ status?: AuthorizationVoidStatusWithLiterals;
4700
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4701
+ voidedDate?: Date | null;
4702
+ /** In case of status is FAILED may contain failure details */
4703
+ failureDetails?: AuthorizationActionFailureDetails;
4704
+ /** Reason of void action */
4705
+ reason?: ReasonWithLiterals;
4792
4706
  }
4793
- interface RedirectUrls {
4794
- /**
4795
- * URL to redirect buyer in case of approved (successful) transaction
4796
- * @format WEB_URL
4797
- */
4798
- successUrl?: string | null;
4799
- /**
4800
- * URL to redirect buyer in case of buyer canceled the transaction
4801
- * @format WEB_URL
4802
- */
4803
- cancelUrl?: string | null;
4804
- /**
4805
- * URL to redirect buyer in case of failed/rejected transaction
4806
- * @format WEB_URL
4807
- */
4808
- errorUrl?: string | null;
4809
- /**
4810
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4811
- * @format WEB_URL
4812
- */
4813
- pendingUrl?: string | null;
4707
+ declare enum AuthorizationVoidStatus {
4708
+ /** Void operation still in progress. */
4709
+ PENDING = "PENDING",
4710
+ /** Void operation succeeded. */
4711
+ SUCCEEDED = "SUCCEEDED",
4712
+ /** Void operation failed. */
4713
+ FAILED = "FAILED"
4814
4714
  }
4815
- interface DelayedCaptureSettings {
4816
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4817
- scheduledAction?: ScheduledActionWithLiterals;
4818
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4819
- delayDuration?: Duration;
4715
+ /** @enumType */
4716
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4717
+ /** Reason the authorization was voided. */
4718
+ declare enum Reason {
4719
+ /** Authorization was voided by user. */
4720
+ MANUAL = "MANUAL",
4721
+ /** Authorization passed execution date. */
4722
+ SCHEDULED = "SCHEDULED"
4820
4723
  }
4821
- declare enum ScheduledAction {
4822
- /** Whether payment will be auto-voided when duration passes */
4724
+ /** @enumType */
4725
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4726
+ interface V1ScheduledAction {
4727
+ /** Type of the action. */
4728
+ actionType?: ActionTypeWithLiterals;
4729
+ /** The date and time of the action. */
4730
+ executionDate?: Date | null;
4731
+ }
4732
+ declare enum ActionType {
4823
4733
  VOID = "VOID",
4824
- /** Whether payment will be auto-captured when duration passes */
4825
4734
  CAPTURE = "CAPTURE"
4826
4735
  }
4827
4736
  /** @enumType */
4828
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4829
- interface Duration {
4737
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4738
+ interface Chargeback {
4830
4739
  /**
4831
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4832
- * @min 1
4740
+ * Chargeback ID.
4741
+ * @format GUID
4742
+ * @readonly
4743
+ * @immutable
4833
4744
  */
4834
- count?: number;
4835
- /** Duration unit: MINUTES, HOURS and DAYS */
4836
- unit?: DurationUnitWithLiterals;
4837
- }
4838
- declare enum DurationUnit {
4839
- MINUTES = "MINUTES",
4840
- HOURS = "HOURS",
4841
- DAYS = "DAYS"
4842
- }
4843
- /** @enumType */
4844
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4845
- interface PreparePaymentCollectionResponse {
4846
- /** Payment gateway order id which is associated with given payment */
4847
- paymentGatewayOrderId?: string;
4848
- }
4849
- interface GetPaymentCollectabilityStatusRequest {
4745
+ _id?: string;
4850
4746
  /**
4851
- * Ecom order ID.
4852
- * @minLength 1
4853
- * @maxLength 100
4747
+ * 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.
4748
+ * @readonly
4749
+ * @immutable
4750
+ */
4751
+ _createdDate?: Date | null;
4752
+ /**
4753
+ * 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.
4754
+ * @readonly
4755
+ */
4756
+ _updatedDate?: Date | null;
4757
+ /**
4758
+ * Amount.
4759
+ * @readonly
4760
+ * @immutable
4854
4761
  */
4855
- ecomOrderId: string;
4856
- }
4857
- interface GetPaymentCollectabilityStatusResponse {
4858
- /** Payment collectability status */
4859
- status?: PaymentCollectabilityStatusWithLiterals;
4860
- /** Collectable order amount */
4861
4762
  amount?: Price;
4862
- }
4863
- declare enum PaymentCollectabilityStatus {
4864
- UNKNOWN = "UNKNOWN",
4865
- COLLECTABLE = "COLLECTABLE",
4866
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4867
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4868
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4869
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4870
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4871
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4872
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4873
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4874
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4875
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
4876
- }
4877
- /** @enumType */
4878
- 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';
4879
- interface RecordManuallyCollectedPaymentRequest {
4880
4763
  /**
4881
- * Order ID.
4882
- * @minLength 1
4883
- * @maxLength 100
4764
+ * Reversal amount. Present only when status is REVERSED.
4765
+ * @readonly
4884
4766
  */
4885
- orderId: string;
4886
- /** Amount to be recorded as approved manual payment for given order */
4887
- amount: Price;
4888
- }
4889
- /**
4890
- * User-defined payment method name.
4891
- * Allows specifying either a predefined type or a custom name.
4892
- */
4893
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4894
- /** Predefined payment method. */
4895
- predefined?: PredefinedPaymentMethodWithLiterals;
4767
+ reversalAmount?: Price;
4896
4768
  /**
4897
- * Custom payment method name provided by user.
4769
+ * Status.
4898
4770
  *
4899
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4900
- * @minLength 1
4901
- * @maxLength 150
4771
+ * Default: `"APPROVED"`.
4902
4772
  */
4903
- custom?: string | null;
4904
- }
4905
- /** @oneof */
4906
- interface UserDefinedPaymentMethodNameKindOneOf {
4907
- /** Predefined payment method. */
4908
- predefined?: PredefinedPaymentMethodWithLiterals;
4773
+ status?: ChargebackStatusWithLiterals;
4909
4774
  /**
4910
- * Custom payment method name provided by user.
4911
- *
4912
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4913
- * @minLength 1
4914
- * @maxLength 150
4775
+ * External chargeback ID.
4776
+ * @format GUID
4777
+ * @readonly
4778
+ * @immutable
4915
4779
  */
4916
- custom?: string | null;
4780
+ externalId?: string | null;
4917
4781
  }
4918
- /** Predefined payment method types for offline/manual payments. */
4919
- declare enum PredefinedPaymentMethod {
4920
- /** Cash payment. */
4921
- CASH = "CASH",
4922
- /** Bank transfer. */
4923
- BANK_TRANSFER = "BANK_TRANSFER",
4924
- /** Payment by check. */
4925
- CHECK = "CHECK"
4782
+ declare enum ChargebackStatus {
4783
+ /** Chargeback was approved. */
4784
+ APPROVED = "APPROVED",
4785
+ /** Chargeback was reversed. */
4786
+ REVERSED = "REVERSED"
4926
4787
  }
4927
4788
  /** @enumType */
4928
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4929
- interface RecordManuallyCollectedPaymentResponse {
4930
- }
4931
- interface MarkOrderAsPaidRequest {
4789
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4790
+ interface PaymentMethodName {
4932
4791
  /**
4933
- * Ecom order ID.
4934
- * @minLength 1
4935
- * @maxLength 100
4792
+ * Translated payment method name in buyer language.
4793
+ * @maxLength 150
4936
4794
  */
4937
- ecomOrderId: string;
4938
- }
4939
- interface MarkOrderAsPaidResponse {
4940
- /** Updated order. */
4941
- order?: Order;
4942
- }
4943
- interface BulkMarkOrdersAsPaidRequest {
4795
+ buyerLanguageName?: string | null;
4944
4796
  /**
4945
- * IDs of orders to mark as paid.
4946
- * @minSize 1
4947
- * @maxSize 100
4948
- * @minLength 1
4949
- * @maxLength 100
4797
+ * Translated payment method name in site owner language.
4798
+ * @maxLength 150
4950
4799
  */
4951
- ecomOrderIds: string[];
4952
- }
4953
- interface BulkMarkOrdersAsPaidResponse {
4800
+ siteLanguageName?: string | null;
4954
4801
  /**
4955
- * Items updated by the bulk action.
4956
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4802
+ * User-provided payment method name.
4803
+ *
4804
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
4957
4805
  */
4958
- results?: BulkOrderResult[];
4959
- /** Bulk action metadata. */
4960
- bulkActionMetadata?: BulkActionMetadata;
4806
+ userDefinedName?: UserDefinedPaymentMethodName;
4961
4807
  }
4962
- interface BulkOrderResult {
4963
- /** Item metadata. */
4964
- itemMetadata?: ItemMetadata;
4808
+ interface GiftCardPaymentDetails {
4965
4809
  /**
4966
- * Updated order.
4967
- *
4968
- * Returned when `returnFullEntity = true`.
4810
+ * Gift card payment ID.
4811
+ * @maxLength 100
4969
4812
  */
4970
- item?: Order;
4971
- }
4972
- interface ItemMetadata {
4973
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4974
- _id?: string | null;
4975
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4976
- originalIndex?: number;
4977
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4978
- success?: boolean;
4979
- /** Details about the error in case of failure. */
4980
- error?: ApplicationError;
4981
- }
4982
- interface ApplicationError {
4983
- /** Error code. */
4984
- code?: string;
4985
- /** Description of the error. */
4986
- description?: string;
4987
- /** Data related to the error. */
4988
- data?: Record<string, any> | null;
4989
- }
4990
- interface BulkActionMetadata {
4991
- /** Number of items that were successfully processed. */
4992
- totalSuccesses?: number;
4993
- /** Number of items that couldn't be processed. */
4994
- totalFailures?: number;
4995
- /** Number of failures without details because detailed failure threshold was exceeded. */
4996
- undetailedFailures?: number;
4813
+ giftCardPaymentId?: string;
4814
+ /**
4815
+ * ID of the app that created the gift card.
4816
+ * @format GUID
4817
+ */
4818
+ appId?: string;
4819
+ /**
4820
+ * Whether the gift card is voided.
4821
+ * @readonly
4822
+ * @deprecated Whether the gift card is voided.
4823
+ * @replacedBy payment.status
4824
+ * @targetRemovalDate 2026-11-01
4825
+ */
4826
+ voided?: boolean;
4827
+ /**
4828
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
4829
+ * @maxLength 30
4830
+ * @immutable
4831
+ */
4832
+ obfuscatedCode?: string | null;
4997
4833
  }
4998
- interface GetRefundabilityStatusRequest {
4834
+ interface MembershipPaymentDetails {
4999
4835
  /**
5000
- * Order ID.
4836
+ * Membership ID.
4837
+ * @maxLength 200
4838
+ */
4839
+ membershipId?: string;
4840
+ /**
4841
+ * ID of the line item this membership applies to.
5001
4842
  * @minLength 1
5002
4843
  * @maxLength 100
5003
4844
  */
5004
- ecomOrderId: string;
5005
- }
5006
- interface GetRefundabilityStatusResponse {
4845
+ lineItemId?: string;
5007
4846
  /**
5008
- * Refundability details.
5009
- * @maxSize 300
4847
+ * Payment status.
4848
+ * @deprecated Payment status.
4849
+ * @replacedBy payment.status
4850
+ * @targetRemovalDate 2026-11-01
5010
4851
  */
5011
- refundabilities?: Refundability[];
4852
+ status?: MembershipPaymentStatusWithLiterals;
4853
+ /** Membership name. */
4854
+ name?: MembershipName;
5012
4855
  /**
5013
- * Whether the order supports refunding per item.
5014
- * @deprecated
4856
+ * The transaction ID in the membership system. Can be used to void the transaction.
4857
+ * @minLength 1
4858
+ * @maxLength 100
5015
4859
  */
5016
- refundablePerItem?: boolean;
5017
- }
5018
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5019
- /** Reason why payment is not refundable. */
5020
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5021
- /** Reason why payment is only refundable manually. */
5022
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5023
- /** Payment ID. */
5024
- paymentId?: string;
5025
- /** Payment refundability status. */
5026
- refundabilityStatus?: RefundableStatusWithLiterals;
5027
- /** Link to payment provider dashboard. */
5028
- providerLink?: string | null;
5029
- }
5030
- /** @oneof */
5031
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5032
- /** Reason why payment is not refundable. */
5033
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5034
- /** Reason why payment is only refundable manually. */
5035
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5036
- }
5037
- declare enum RefundableStatus {
5038
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5039
- MANUAL = "MANUAL",
5040
- REFUNDABLE = "REFUNDABLE"
5041
- }
5042
- /** @enumType */
5043
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5044
- declare enum NonRefundableReason {
5045
- NONE = "NONE",
5046
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5047
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5048
- INTERNAL_ERROR = "INTERNAL_ERROR",
5049
- NOT_PAID = "NOT_PAID",
5050
- ACCESS_DENIED = "ACCESS_DENIED",
5051
- ZERO_PRICE = "ZERO_PRICE",
5052
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5053
- PENDING_REFUND = "PENDING_REFUND",
5054
- FORBIDDEN = "FORBIDDEN",
5055
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5056
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5057
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4860
+ externalTransactionId?: string | null;
4861
+ /**
4862
+ * Whether the membership is voided.
4863
+ * @readonly
4864
+ * @deprecated Whether the membership is voided.
4865
+ * @replacedBy payment.status
4866
+ * @targetRemovalDate 2026-11-01
4867
+ */
4868
+ voided?: boolean;
4869
+ /**
4870
+ * ID of the application providing this payment option.
4871
+ * @format GUID
4872
+ */
4873
+ providerAppId?: string;
4874
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
4875
+ futureMembership?: FutureMembershipDetails;
5058
4876
  }
5059
- /** @enumType */
5060
- 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';
5061
- declare enum ManuallyRefundableReason {
5062
- EXPIRED = "EXPIRED",
5063
- NOT_SUPPORTED = "NOT_SUPPORTED",
5064
- OFFLINE = "OFFLINE",
5065
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4877
+ declare enum MembershipPaymentStatus {
4878
+ /** Payment was charged. */
4879
+ CHARGED = "CHARGED",
4880
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
4881
+ CHARGE_FAILED = "CHARGE_FAILED",
4882
+ /** Payment is pending. */
4883
+ CHARGE_PENDING = "CHARGE_PENDING",
4884
+ /** Payment was voided. */
4885
+ VOIDED = "VOIDED"
5066
4886
  }
5067
4887
  /** @enumType */
5068
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5069
- interface CreatePaymentGatewayOrderRequest {
4888
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
4889
+ interface FutureMembershipDetails {
5070
4890
  /**
5071
- * Ecom order ID.
5072
- * @minLength 1
5073
- * @maxLength 100
4891
+ * ID of the plan line item in the order from which the membership will be created.
4892
+ * @format GUID
5074
4893
  */
5075
- ecomOrderId: string;
5076
- /** Information about the user who initiated the payment. */
5077
- chargedBy?: ChargedBy;
4894
+ lineItemId?: string;
4895
+ /**
4896
+ * ID of the benefit the future membership will grant.
4897
+ * @maxLength 200
4898
+ */
4899
+ benefitId?: string;
5078
4900
  }
5079
- interface ChargedBy {
4901
+ interface WixReceiptInfo {
5080
4902
  /**
5081
- * ID - id of the user who initiated the payment
4903
+ * Receipt ID
5082
4904
  * @format GUID
5083
4905
  */
5084
- _id?: string;
4906
+ receiptId?: string;
5085
4907
  /**
5086
- * Full name - name of the user who initiated the payment
4908
+ * Display number of receipt
5087
4909
  * @minLength 1
5088
- * @maxLength 200
4910
+ * @maxLength 40
5089
4911
  */
5090
- fullName?: string | null;
5091
- }
5092
- interface CreatePaymentGatewayOrderResponse {
5093
- /** ID of the order created in the payment gateway */
5094
- paymentGatewayOrderId?: string;
4912
+ displayNumber?: string | null;
5095
4913
  }
5096
- interface ChargeMembershipsRequest {
4914
+ interface ExternalReceiptInfo {
5097
4915
  /**
5098
- * Order ID.
5099
- * @minLength 1
4916
+ * External receipt ID
5100
4917
  * @maxLength 100
5101
4918
  */
5102
- ecomOrderId: string;
4919
+ receiptId?: string | null;
5103
4920
  /**
5104
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5105
- * but a user which is using the membership on behalf of the a member
4921
+ * ID of the app providing the receipt
5106
4922
  * @format GUID
5107
4923
  */
5108
- memberId: string;
4924
+ appId?: string | null;
5109
4925
  /**
5110
- * List of items to be paid by memberships
5111
- * @minSize 1
5112
- * @maxSize 300
4926
+ * Display number of receipt
4927
+ * @minLength 1
4928
+ * @maxLength 40
5113
4929
  */
5114
- membershipCharges?: MembershipChargeItem[];
4930
+ displayNumber?: string | null;
5115
4931
  }
5116
- interface MembershipChargeItem {
4932
+ interface CashRoundingDetails {
5117
4933
  /**
5118
- * The id of used membership
5119
- * @minLength 1
5120
- * @maxLength 100
4934
+ * Payment amount before cash rounding was applied.
4935
+ * When provided, balance and status calculations use this value instead of `amount`
4936
+ * to prevent false overpayment or underpayment due to rounding.
5121
4937
  */
5122
- membershipId?: string;
4938
+ unroundedAmount?: Price;
4939
+ /**
4940
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
4941
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
4942
+ * @readonly
4943
+ */
4944
+ roundingAdjustment?: CashRounding;
4945
+ }
4946
+ declare enum PaymentStatus {
4947
+ /** Payment was charged successfully. */
4948
+ APPROVED = "APPROVED",
4949
+ /** Payment is being processed and hasn't been confirmed yet. */
4950
+ PENDING = "PENDING",
4951
+ /** 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. */
4952
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4953
+ /** Payment was canceled before it was charged. */
4954
+ CANCELED = "CANCELED",
4955
+ /** Payment was declined by the payment provider. */
4956
+ DECLINED = "DECLINED",
4957
+ /** Payment was fully refunded. */
4958
+ REFUNDED = "REFUNDED",
4959
+ /** Part of the payment amount was refunded. */
4960
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4961
+ /** 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. */
4962
+ AUTHORIZED = "AUTHORIZED",
4963
+ /**
4964
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
4965
+ *
4966
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
4967
+ */
4968
+ VOIDED = "VOIDED"
4969
+ }
4970
+ /** @enumType */
4971
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4972
+ interface CanceledStatusDetails {
4973
+ reason?: CanceledReasonWithLiterals;
4974
+ }
4975
+ declare enum CanceledReason {
4976
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
4977
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
4978
+ /** Payment was not completed by user and expired. */
4979
+ EXPIRED = "EXPIRED"
4980
+ }
4981
+ /** @enumType */
4982
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
4983
+ interface DeclinedStatusDetails {
4984
+ reason?: DeclinedReasonWithLiterals;
4985
+ }
4986
+ declare enum DeclinedReason {
4987
+ /** Corresponding charge failed. */
4988
+ CHARGE_FAILED = "CHARGE_FAILED",
4989
+ /** Payment details expired. */
4990
+ EXPIRED = "EXPIRED",
4991
+ /** Insufficient funds. */
4992
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
4993
+ /** Gift card was disabled before charge was attempted. */
4994
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
4995
+ }
4996
+ /** @enumType */
4997
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
4998
+ interface VoidedStatusDetails {
4999
+ reason?: VoidedReasonWithLiterals;
5000
+ }
5001
+ declare enum VoidedReason {
5002
+ /** Payment was voided by merchant request. */
5003
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5004
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5005
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5006
+ }
5007
+ /** @enumType */
5008
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5009
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5010
+ }
5011
+ /** @oneof */
5012
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5013
+ }
5014
+ interface Refund {
5123
5015
  /**
5124
- * ID of the application providing this payment option
5016
+ * Refund ID.
5125
5017
  * @format GUID
5018
+ * @readonly
5126
5019
  */
5127
- appId?: string;
5128
- /** The name of used membership */
5129
- membershipName?: MembershipName;
5130
- /** Additional data about this membership */
5131
- membershipAdditionalData?: Record<string, any> | null;
5132
- /** Catalog and item reference info. */
5133
- catalogReference?: CatalogReference;
5134
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5135
- serviceProperties?: ServiceProperties;
5020
+ _id?: string;
5136
5021
  /**
5137
- * Usually would be the same as catalogReference.catalogItemId
5138
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5139
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5140
- * @minLength 1
5141
- * @maxLength 36
5022
+ * List of transactions.
5023
+ * @maxSize 50
5142
5024
  */
5143
- rootCatalogItemId?: string | null;
5025
+ transactions?: RefundTransaction[];
5026
+ /** Refund business details. */
5027
+ details?: RefundDetails;
5144
5028
  /**
5145
- * line item id of Checkout/Order line item
5146
- * @minLength 1
5147
- * @maxLength 100
5029
+ * 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.
5030
+ * @readonly
5031
+ * @immutable
5148
5032
  */
5149
- lineItemId?: string;
5150
- }
5151
- interface MembershipName {
5033
+ _createdDate?: Date | null;
5152
5034
  /**
5153
- * Membership name.
5154
- * @maxLength 100
5035
+ * Aggregated refund summary.
5036
+ * @readonly
5155
5037
  */
5156
- original?: string;
5038
+ summary?: AggregatedRefundSummary;
5157
5039
  /**
5158
- * Translated membership name. Defaults to `original` when not provided.
5159
- * @maxLength 100
5040
+ * ID of the app that initiated this refund.
5041
+ * @format GUID
5042
+ * @readonly
5043
+ * @immutable
5160
5044
  */
5161
- translated?: string | null;
5162
- }
5163
- interface ChargeMembershipsResponse {
5045
+ requestingServiceAppId?: string | null;
5164
5046
  }
5165
- interface TriggerRefundRequest {
5047
+ interface RefundTransaction {
5166
5048
  /**
5167
- * The order this refund related to
5168
- * @minLength 1
5169
- * @maxLength 100
5049
+ * ID of the payment associated with this refund.
5050
+ * @format GUID
5051
+ * @immutable
5170
5052
  */
5171
- ecomOrderId: string;
5053
+ paymentId?: string;
5172
5054
  /**
5173
- * Refund operations information
5174
- * @minSize 1
5175
- * @maxSize 1
5055
+ * Refund amount.
5056
+ * @immutable
5176
5057
  */
5177
- payments: PaymentRefund[];
5178
- /** Business model of a refund */
5179
- details?: RefundDetails;
5180
- /** Side effect details related to refund */
5181
- sideEffects?: RefundSideEffects;
5182
- }
5183
- interface PaymentRefund {
5058
+ amount?: Price;
5059
+ /** Refund status. */
5060
+ refundStatus?: RefundStatusWithLiterals;
5061
+ /** Optional details of current refund status. */
5062
+ refundStatusInfo?: RefundStatusInfo;
5184
5063
  /**
5185
- * Specific payment within the order to refund
5064
+ * Payment gateway's refund ID.
5065
+ * This field is only returned when the value of `external_refund` is `false`.
5186
5066
  * @format GUID
5187
5067
  */
5188
- paymentId?: string;
5189
- /** Refund amount. Not relevant for membership and gift card refunds. */
5190
- amount?: Price;
5068
+ gatewayRefundId?: string | null;
5069
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5070
+ providerRefundId?: string | null;
5191
5071
  /**
5192
- * Whether refund is made externally and manually (on the payment provider's side)
5193
- * 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.
5194
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5072
+ * Whether refund was made externally and manually on the payment provider's side.
5073
+ * @immutable
5195
5074
  */
5196
5075
  externalRefund?: boolean;
5197
5076
  }
5198
- interface RefundSideEffects {
5199
- /** Inventory restock details as part of this refund. */
5200
- restockInfo?: RestockInfo;
5201
- /** Whether to send a refund confirmation email to the customer. */
5202
- sendOrderRefundedEmail?: boolean;
5077
+ /** Refund transaction status. */
5078
+ declare enum RefundStatus {
5079
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5080
+ PENDING = "PENDING",
5081
+ /** Refund transaction succeeded. */
5082
+ SUCCEEDED = "SUCCEEDED",
5083
+ /** Refund transaction failed. */
5084
+ FAILED = "FAILED",
5085
+ /** Refund request acknowledged, and will be executed soon. */
5086
+ SCHEDULED = "SCHEDULED",
5087
+ /** Refund was initiated on payment provider side. */
5088
+ STARTED = "STARTED"
5089
+ }
5090
+ /** @enumType */
5091
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5092
+ interface RefundStatusInfo {
5203
5093
  /**
5204
- * Custom message added to the refund confirmation email.
5094
+ * Reason code for the refund's current status.
5095
+ *
5096
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5097
+ * @minLength 1
5098
+ * @maxLength 10
5099
+ */
5100
+ paymentGatewayReasonCode?: string | null;
5101
+ /**
5102
+ * Free text explanation of current refund status.
5205
5103
  * @minLength 1
5206
5104
  * @maxLength 1000
5207
5105
  */
5208
- customMessage?: string | null;
5106
+ description?: string | null;
5209
5107
  }
5210
- interface RestockInfo {
5211
- /** Restock type. */
5212
- type?: RestockTypeWithLiterals;
5108
+ interface AggregatedRefundSummary {
5109
+ /** Total amount requested for refund. */
5110
+ requestedRefund?: Price;
5111
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5112
+ pendingRefund?: Price;
5113
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5114
+ refunded?: Price;
5115
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
5116
+ failedRefundAmount?: Price;
5117
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
5118
+ pending?: boolean;
5119
+ /** Breakdown of refunded items. Available only after refund is complete. */
5120
+ breakdown?: RefundItemsBreakdown;
5121
+ }
5122
+ interface RefundItemsBreakdown {
5213
5123
  /**
5214
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5124
+ * Refunded line items and the amount refunded for each.
5215
5125
  * @maxSize 300
5216
5126
  */
5217
- items?: RestockItem[];
5218
- }
5219
- declare enum RestockType {
5220
- NO_ITEMS = "NO_ITEMS",
5221
- ALL_ITEMS = "ALL_ITEMS",
5222
- SOME_ITEMS = "SOME_ITEMS"
5127
+ lineItems?: LineItemRefundSummary[];
5223
5128
  }
5224
- /** @enumType */
5225
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5226
- interface RestockItem {
5129
+ interface LineItemRefundSummary {
5227
5130
  /**
5228
- * ID of the line item being restocked.
5131
+ * ID of the refunded line item.
5229
5132
  * @format GUID
5230
5133
  */
5231
5134
  lineItemId?: string;
5232
- /**
5233
- * Line item quantity being restocked.
5234
- * @min 1
5235
- * @max 100000
5236
- */
5237
- quantity?: number;
5238
- }
5239
- interface TriggerRefundResponse {
5240
- /** All order's transactions after the refunds were added */
5241
- orderTransactions?: OrderTransactions;
5242
- /** Created refund ID */
5243
- refundId?: string | null;
5244
- /** Payment ID's that the refund execution had failed for */
5245
- failedPaymentIds?: ItemMetadata[];
5135
+ /** Total refunded amount for the line item. */
5136
+ totalRefundedAmount?: Price;
5246
5137
  }
5247
- /**
5248
- * A record of all payments and refunds associated with an order.
5249
- *
5250
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5251
- */
5252
- interface OrderTransactions {
5253
- /**
5254
- * Order ID.
5255
- * @format GUID
5256
- */
5257
- orderId?: string;
5138
+ interface CalculateRefundRequest {
5258
5139
  /**
5259
- * Record of payments made to the merchant.
5260
- * @maxSize 100
5140
+ * Order ID
5141
+ * @minLength 1
5142
+ * @maxLength 100
5261
5143
  */
5262
- payments?: Payment[];
5144
+ ecomOrderId?: string;
5263
5145
  /**
5264
- * Record of refunds made to the buyer.
5146
+ * Refunded line items and quantity
5265
5147
  * @maxSize 300
5266
5148
  */
5267
- refunds?: Refund[];
5149
+ refundItems?: CalculateRefundItemRequest[];
5150
+ /** Should include shipping in refund calculation */
5151
+ refundShipping?: boolean;
5268
5152
  }
5269
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5270
- /** Regular payment details. */
5271
- regularPaymentDetails?: RegularPaymentDetails;
5272
- /** Gift card payment details. */
5273
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5274
- /** Membership payment details. */
5275
- membershipPaymentDetails?: MembershipPaymentDetails;
5153
+ interface CalculateRefundItemRequest {
5276
5154
  /**
5277
- * Payment ID.
5155
+ * ID of the line item being refunded
5278
5156
  * @format GUID
5279
- * @readonly
5280
- */
5281
- _id?: string | null;
5282
- /** 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. */
5283
- _createdDate?: Date | null;
5284
- /**
5285
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5286
- * @readonly
5287
- */
5288
- _updatedDate?: Date | null;
5289
- /** Payment amount. */
5290
- amount?: Price;
5291
- /**
5292
- * Whether refunds for this payment are disabled.
5293
- * + `true`: This payment is not refundable.
5294
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5295
- */
5296
- refundDisabled?: boolean;
5297
- /**
5298
- * Whether receipt generation is allowed for this payment.
5299
- * + `true`: This payment supports receipt generation.
5300
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5301
- * @readonly
5302
5157
  */
5303
- supportReceiptGeneration?: boolean;
5304
- /** Details about cash rounding applied to this payment, when relevant. */
5305
- cashRounding?: CashRoundingDetails;
5158
+ _id?: string;
5306
5159
  /**
5307
- * Overall payment status.
5308
- *
5309
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5160
+ * How much of that line item is being refunded
5161
+ * @min 1
5162
+ * @max 100000
5310
5163
  */
5311
- status?: PaymentStatusWithLiterals;
5164
+ quantity?: number;
5165
+ }
5166
+ interface CalculateRefundResponse {
5167
+ /** Total refundable amount */
5168
+ total?: Price;
5169
+ /** Tax cost of the order */
5170
+ tax?: Price;
5171
+ /** Discount given for this order */
5172
+ discount?: Price;
5173
+ /** Total cost of the order (without tax) */
5174
+ subtotal?: Price;
5175
+ /** Total shipping cost for order */
5176
+ shipping?: Price;
5177
+ /** Previous refund given on that order */
5178
+ previouslyRefundedAmount?: Price;
5312
5179
  /**
5313
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5314
- * @format GUID
5180
+ * The refundable items of that order
5181
+ * @maxSize 300
5315
5182
  */
5316
- chargeCorrelationId?: string | null;
5317
- }
5318
- /** @oneof */
5319
- interface PaymentPaymentDetailsOneOf {
5320
- /** Regular payment details. */
5321
- regularPaymentDetails?: RegularPaymentDetails;
5322
- /** Gift card payment details. */
5323
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5324
- /** Membership payment details. */
5325
- membershipPaymentDetails?: MembershipPaymentDetails;
5326
- }
5327
- /** @oneof */
5328
- interface PaymentReceiptInfoOneOf {
5329
- }
5330
- /** @oneof */
5331
- interface PaymentStatusDetailsOneOf {
5183
+ items?: CalculateRefundItemResponse[];
5332
5184
  }
5333
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5334
- /** Credit card details. */
5335
- creditCardDetails?: CreditCardPaymentMethodDetails;
5185
+ interface CalculateRefundItemResponse {
5336
5186
  /**
5337
- * Wix Payments order ID.
5338
- * @maxLength 100
5187
+ * Line item ID
5188
+ * @format GUID
5339
5189
  */
5340
- paymentOrderId?: string | null;
5190
+ _id?: string;
5191
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5192
+ price?: Price;
5193
+ }
5194
+ interface VoidAuthorizedPaymentsRequest {
5341
5195
  /**
5342
- * Payment gateway's transaction ID.
5343
- * This field is only returned when the value of `offline_payment` is `false`.
5196
+ * Wix eCommerce order ID
5197
+ * @minLength 1
5344
5198
  * @maxLength 100
5345
5199
  */
5346
- gatewayTransactionId?: string | null;
5200
+ ecomOrderId: string;
5347
5201
  /**
5348
- * Payment method.
5349
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5350
- * Non-exhaustive list of supported values:
5351
- * + `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`
5352
- * @maxLength 150
5353
- * @deprecated Payment method.
5354
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5355
- * Non-exhaustive list of supported values:
5356
- * + `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`
5357
- * @replacedBy payment_method_name
5358
- * @targetRemovalDate 2026-07-01
5202
+ * Payment IDs
5203
+ * @minSize 1
5204
+ * @maxSize 100
5205
+ * @format GUID
5359
5206
  */
5360
- paymentMethod?: string | null;
5207
+ paymentIds: string[];
5208
+ }
5209
+ interface VoidAuthorizedPaymentsResponse {
5210
+ /** All order's transactions after the void was triggered */
5211
+ orderTransactions?: OrderTransactions;
5212
+ }
5213
+ interface CaptureAuthorizedPaymentsRequest {
5361
5214
  /**
5362
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5215
+ * Wix eCommerce order ID
5216
+ * @minLength 1
5363
5217
  * @maxLength 100
5364
5218
  */
5365
- providerTransactionId?: string | null;
5366
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5367
- offlinePayment?: boolean;
5219
+ ecomOrderId: string;
5368
5220
  /**
5369
- * Payment status.
5370
- * @deprecated Payment status.
5371
- * @replacedBy payment.status
5372
- * @targetRemovalDate 2026-11-01
5221
+ * Capture payments information
5222
+ * @minSize 1
5223
+ * @maxSize 100
5373
5224
  */
5374
- status?: TransactionStatusWithLiterals;
5375
- /** Whether there is a payment agreement that allows for future charges. */
5376
- savedPaymentMethod?: boolean;
5377
- /** Authorization details. */
5378
- authorizationDetails?: AuthorizationDetails;
5225
+ payments: PaymentCapture[];
5226
+ }
5227
+ interface PaymentCapture {
5379
5228
  /**
5380
- * Record of chargebacks made by the buyer.
5381
- * @maxSize 6
5229
+ * Payment ID
5230
+ * @format GUID
5382
5231
  */
5383
- chargebacks?: Chargeback[];
5384
- /** Platform fee amount associated with this payment. */
5385
- platformFee?: Price;
5232
+ paymentId?: string | null;
5386
5233
  /**
5387
- * Payment method with buyer and optional owner translations.
5388
- * Non-exhaustive list of supported values:
5389
- * + `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`
5234
+ * Capture amount.
5235
+ * If not provided - full authorized amount will be captured.
5390
5236
  */
5391
- paymentMethodName?: PaymentMethodName;
5392
- }
5393
- /** @oneof */
5394
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5395
- /** Credit card details. */
5396
- creditCardDetails?: CreditCardPaymentMethodDetails;
5237
+ amount?: Price;
5397
5238
  }
5398
- declare enum TransactionStatus {
5399
- UNDEFINED = "UNDEFINED",
5400
- APPROVED = "APPROVED",
5401
- PENDING = "PENDING",
5402
- PENDING_MERCHANT = "PENDING_MERCHANT",
5403
- CANCELED = "CANCELED",
5404
- DECLINED = "DECLINED",
5405
- REFUNDED = "REFUNDED",
5406
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5407
- AUTHORIZED = "AUTHORIZED",
5408
- VOIDED = "VOIDED"
5239
+ interface CaptureAuthorizedPaymentsResponse {
5240
+ /** All order's transactions after the capture was triggered */
5241
+ orderTransactions?: OrderTransactions;
5409
5242
  }
5410
- /** @enumType */
5411
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5412
- interface CreditCardPaymentMethodDetails {
5413
- /**
5414
- * The last 4 digits of the card number.
5415
- * @maxLength 4
5416
- */
5417
- lastFourDigits?: string | null;
5243
+ interface ChargeSavedPaymentMethodRequest {
5418
5244
  /**
5419
- * Card issuer's brand.
5245
+ * Ecom Order ID.
5246
+ * @minLength 1
5420
5247
  * @maxLength 100
5421
5248
  */
5422
- brand?: string | null;
5249
+ ecomOrderId?: string;
5250
+ /** Amount to be charged */
5251
+ amount?: Price;
5423
5252
  }
5424
- interface AuthorizationDetails {
5425
- /**
5426
- * Whether the authorized payment is of a delayed capture.
5427
- * @readonly
5428
- */
5429
- delayedCapture?: boolean;
5430
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5431
- authorizedDate?: Date | null;
5253
+ interface ChargeSavedPaymentMethodResponse {
5254
+ /** Payment gateway's order ID (e.g Wix Payments) */
5255
+ paymentGatewayOrderId?: string;
5256
+ }
5257
+ interface SendBuyerConfirmationEmailRequest {
5258
+ /** @format GUID */
5259
+ orderId?: string;
5260
+ }
5261
+ interface SendBuyerConfirmationEmailResponse {
5262
+ }
5263
+ interface SendBuyerPaymentsReceivedEmailRequest {
5432
5264
  /**
5433
- * List of captures associated with payment
5434
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5435
- * @maxSize 1
5265
+ * @minLength 1
5266
+ * @maxLength 100
5436
5267
  */
5437
- captures?: AuthorizationCapture[];
5438
- /** Void associated with payment */
5439
- void?: AuthorizationVoid;
5440
- /** Scheduled action for this transaction */
5441
- scheduledAction?: V1ScheduledAction;
5268
+ orderId?: string;
5442
5269
  }
5443
- interface AuthorizationCapture {
5270
+ interface SendBuyerPaymentsReceivedEmailResponse {
5271
+ }
5272
+ interface SendBuyerPickupConfirmationEmailRequest {
5444
5273
  /**
5445
- * Capture ID.
5446
- * @format GUID
5447
- * @readonly
5274
+ * @minLength 1
5275
+ * @maxLength 100
5448
5276
  */
5449
- _id?: string | null;
5450
- /** Status of this capture action */
5451
- status?: AuthorizationCaptureStatusWithLiterals;
5277
+ orderId?: string;
5278
+ }
5279
+ interface SendBuyerPickupConfirmationEmailResponse {
5280
+ }
5281
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
5452
5282
  /**
5453
- * Amount of this capture
5454
- * @immutable
5283
+ * IDs of orders to send pickup emails for.
5284
+ * @minSize 1
5285
+ * @maxSize 300
5455
5286
  */
5456
- amount?: Price;
5457
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5458
- _createdDate?: Date | null;
5459
- /** In case of status is FAILED may contain failure details */
5460
- failureDetails?: AuthorizationActionFailureDetails;
5287
+ orderIds?: string[];
5461
5288
  }
5462
- declare enum AuthorizationCaptureStatus {
5463
- /** Capture operation still in progress. */
5464
- PENDING = "PENDING",
5465
- /** Capture operation succeeded. */
5466
- SUCCEEDED = "SUCCEEDED",
5467
- /** Capture operation failed. */
5468
- FAILED = "FAILED"
5289
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
5469
5290
  }
5470
- /** @enumType */
5471
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5472
- interface AuthorizationActionFailureDetails {
5473
- /** @maxLength 100 */
5474
- failureCode?: string;
5291
+ interface SendBuyerShippingConfirmationEmailRequest {
5292
+ /**
5293
+ * @minLength 1
5294
+ * @maxLength 100
5295
+ */
5296
+ orderId?: string;
5475
5297
  }
5476
- interface AuthorizationVoid {
5477
- /** Status of this void action */
5478
- status?: AuthorizationVoidStatusWithLiterals;
5479
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5480
- voidedDate?: Date | null;
5481
- /** In case of status is FAILED may contain failure details */
5482
- failureDetails?: AuthorizationActionFailureDetails;
5483
- /** Reason of void action */
5484
- reason?: ReasonWithLiterals;
5298
+ interface SendBuyerShippingConfirmationEmailResponse {
5485
5299
  }
5486
- declare enum AuthorizationVoidStatus {
5487
- /** Void operation still in progress. */
5488
- PENDING = "PENDING",
5489
- /** Void operation succeeded. */
5490
- SUCCEEDED = "SUCCEEDED",
5491
- /** Void operation failed. */
5492
- FAILED = "FAILED"
5300
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
5301
+ /**
5302
+ * IDs of orders to send pickup emails for.
5303
+ * @minSize 1
5304
+ * @maxSize 300
5305
+ */
5306
+ orderIds?: string[];
5493
5307
  }
5494
- /** @enumType */
5495
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5496
- /** Reason the authorization was voided. */
5497
- declare enum Reason {
5498
- /** Authorization was voided by user. */
5499
- MANUAL = "MANUAL",
5500
- /** Authorization passed execution date. */
5501
- SCHEDULED = "SCHEDULED"
5308
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
5502
5309
  }
5503
- /** @enumType */
5504
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5505
- interface V1ScheduledAction {
5506
- /** Type of the action. */
5507
- actionType?: ActionTypeWithLiterals;
5508
- /** The date and time of the action. */
5509
- executionDate?: Date | null;
5310
+ interface SendMerchantOrderReceivedNotificationRequest {
5311
+ /**
5312
+ * @minLength 1
5313
+ * @maxLength 100
5314
+ */
5315
+ orderId?: string;
5510
5316
  }
5511
- declare enum ActionType {
5512
- VOID = "VOID",
5513
- CAPTURE = "CAPTURE"
5317
+ interface SendMerchantOrderReceivedNotificationResponse {
5514
5318
  }
5515
- /** @enumType */
5516
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5517
- interface Chargeback {
5319
+ interface SendCancelRefundEmailRequest {
5518
5320
  /**
5519
- * Chargeback ID.
5520
- * @format GUID
5521
- * @readonly
5522
- * @immutable
5321
+ * The ID of order that is canceled/refunded
5322
+ * @minLength 1
5323
+ * @maxLength 100
5523
5324
  */
5524
- _id?: string;
5325
+ orderId?: string;
5525
5326
  /**
5526
- * 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.
5527
- * @readonly
5528
- * @immutable
5327
+ * Personal note added to the email (optional)
5328
+ * @minLength 1
5329
+ * @maxLength 1000
5529
5330
  */
5530
- _createdDate?: Date | null;
5331
+ customMessage?: string | null;
5332
+ /** Refund amount */
5333
+ refundAmount?: Price;
5531
5334
  /**
5532
- * 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.
5533
- * @readonly
5335
+ * Refund ID. (Optional)
5336
+ * @format GUID
5534
5337
  */
5535
- _updatedDate?: Date | null;
5338
+ refundId?: string | null;
5339
+ }
5340
+ interface SendCancelRefundEmailResponse {
5341
+ }
5342
+ interface SendRefundEmailRequest {
5536
5343
  /**
5537
- * Amount.
5538
- * @readonly
5539
- * @immutable
5344
+ * The ID of order that is refunded
5345
+ * @format GUID
5540
5346
  */
5541
- amount?: Price;
5347
+ orderId?: string;
5542
5348
  /**
5543
- * Reversal amount. Present only when status is REVERSED.
5544
- * @readonly
5349
+ * Refund ID
5350
+ * @format GUID
5545
5351
  */
5546
- reversalAmount?: Price;
5352
+ refundId?: string;
5547
5353
  /**
5548
- * Status.
5549
- *
5550
- * Default: `"APPROVED"`.
5354
+ * Personal note added to the email (optional)
5355
+ * @minLength 1
5356
+ * @maxLength 1000
5551
5357
  */
5552
- status?: ChargebackStatusWithLiterals;
5358
+ customMessage?: string | null;
5359
+ }
5360
+ interface SendRefundEmailResponse {
5361
+ }
5362
+ interface SendFulfillmentEmailRequest {
5363
+ /** @format GUID */
5364
+ orderId?: string;
5365
+ /** @format GUID */
5366
+ fulfillerId?: string;
5367
+ }
5368
+ interface SendFulfillmentEmailResponse {
5369
+ }
5370
+ interface SendMerchantOrderReceivedPushRequest {
5553
5371
  /**
5554
- * External chargeback ID.
5555
- * @format GUID
5556
- * @readonly
5557
- * @immutable
5372
+ * @minLength 1
5373
+ * @maxLength 100
5558
5374
  */
5559
- externalId?: string | null;
5375
+ orderId?: string;
5560
5376
  }
5561
- declare enum ChargebackStatus {
5562
- /** Chargeback was approved. */
5563
- APPROVED = "APPROVED",
5564
- /** Chargeback was reversed. */
5565
- REVERSED = "REVERSED"
5377
+ interface SendMerchantOrderReceivedPushResponse {
5378
+ }
5379
+ interface PreviewEmailByTypeRequest {
5380
+ emailType?: PreviewEmailTypeWithLiterals;
5381
+ }
5382
+ declare enum PreviewEmailType {
5383
+ ORDER_PLACED = "ORDER_PLACED",
5384
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5385
+ ORDER_SHIPPED = "ORDER_SHIPPED",
5386
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5566
5387
  }
5567
5388
  /** @enumType */
5568
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5569
- interface PaymentMethodName {
5389
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5390
+ interface PreviewEmailByTypeResponse {
5391
+ emailPreview?: string;
5392
+ }
5393
+ interface PreviewRefundEmailRequest {
5570
5394
  /**
5571
- * Translated payment method name in buyer language.
5572
- * @maxLength 150
5395
+ * @minLength 1
5396
+ * @maxLength 100
5573
5397
  */
5574
- buyerLanguageName?: string | null;
5398
+ orderId?: string;
5399
+ /** Refund amount */
5400
+ refundAmount?: Price;
5401
+ /** Refund business details */
5402
+ details?: RefundDetails;
5575
5403
  /**
5576
- * Translated payment method name in site owner language.
5577
- * @maxLength 150
5404
+ * Personal note added to the email (optional)
5405
+ * @minLength 1
5406
+ * @maxLength 1000
5578
5407
  */
5579
- siteLanguageName?: string | null;
5408
+ customMessage?: string | null;
5580
5409
  /**
5581
- * User-provided payment method name.
5582
- *
5583
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5410
+ * Refund ID. (Optional)
5411
+ * @format GUID
5584
5412
  */
5585
- userDefinedName?: UserDefinedPaymentMethodName;
5413
+ refundId?: string | null;
5586
5414
  }
5587
- interface GiftCardPaymentDetails {
5415
+ interface PreviewRefundEmailResponse {
5416
+ emailPreview?: string;
5417
+ }
5418
+ interface PreviewCancelEmailRequest {
5588
5419
  /**
5589
- * Gift card payment ID.
5420
+ * @minLength 1
5590
5421
  * @maxLength 100
5591
5422
  */
5592
- giftCardPaymentId?: string;
5423
+ orderId?: string;
5593
5424
  /**
5594
- * ID of the app that created the gift card.
5595
- * @format GUID
5425
+ * Personal note added to the email (optional)
5426
+ * @minLength 1
5427
+ * @maxLength 1000
5596
5428
  */
5597
- appId?: string;
5429
+ customMessage?: string | null;
5430
+ }
5431
+ interface PreviewCancelEmailResponse {
5432
+ emailPreview?: string;
5433
+ }
5434
+ interface PreviewCancelRefundEmailRequest {
5598
5435
  /**
5599
- * Whether the gift card is voided.
5600
- * @readonly
5601
- * @deprecated Whether the gift card is voided.
5602
- * @replacedBy payment.status
5603
- * @targetRemovalDate 2026-11-01
5436
+ * @minLength 1
5437
+ * @maxLength 100
5604
5438
  */
5605
- voided?: boolean;
5439
+ orderId?: string;
5606
5440
  /**
5607
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5608
- * @maxLength 30
5609
- * @immutable
5441
+ * Personal note added to the email (optional)
5442
+ * @minLength 1
5443
+ * @maxLength 1000
5610
5444
  */
5611
- obfuscatedCode?: string | null;
5445
+ customMessage?: string | null;
5446
+ /** Refund amount */
5447
+ refundAmount?: Price;
5448
+ /**
5449
+ * Refund ID. (Optional)
5450
+ * @format GUID
5451
+ */
5452
+ refundId?: string | null;
5612
5453
  }
5613
- interface MembershipPaymentDetails {
5454
+ interface PreviewCancelRefundEmailResponse {
5455
+ emailPreview?: string;
5456
+ }
5457
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5458
+ }
5459
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5460
+ emailPreview?: string;
5461
+ }
5462
+ interface PreviewBuyerConfirmationEmailRequest {
5463
+ }
5464
+ interface PreviewBuyerConfirmationEmailResponse {
5465
+ emailPreview?: string;
5466
+ }
5467
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5468
+ }
5469
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5470
+ emailPreview?: string;
5471
+ }
5472
+ interface PreviewShippingConfirmationEmailRequest {
5473
+ }
5474
+ interface PreviewShippingConfirmationEmailResponse {
5475
+ emailPreview?: string;
5476
+ }
5477
+ interface PreviewResendDownloadLinksEmailRequest {
5478
+ }
5479
+ interface PreviewResendDownloadLinksEmailResponse {
5480
+ emailPreview?: string;
5481
+ }
5482
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5483
+ /** Emitted on a meta site creation. */
5484
+ siteCreated?: SiteCreated;
5485
+ /** Emitted on a meta site transfer completion. */
5486
+ siteTransferred?: SiteTransferred;
5487
+ /** Emitted on a meta site deletion. */
5488
+ siteDeleted?: SiteDeleted;
5489
+ /** Emitted on a meta site restoration. */
5490
+ siteUndeleted?: SiteUndeleted;
5491
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5492
+ sitePublished?: SitePublished;
5493
+ /** Emitted on a meta site unpublish. */
5494
+ siteUnpublished?: SiteUnpublished;
5495
+ /** Emitted when meta site is marked as template. */
5496
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5497
+ /** Emitted when meta site is marked as a WixSite. */
5498
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5499
+ /** Emitted when an application is provisioned (installed). */
5500
+ serviceProvisioned?: ServiceProvisioned;
5501
+ /** Emitted when an application is removed (uninstalled). */
5502
+ serviceRemoved?: ServiceRemoved;
5503
+ /** Emitted when meta site name (URL slug) is changed. */
5504
+ siteRenamedPayload?: SiteRenamed;
5505
+ /** Emitted when meta site was permanently deleted. */
5506
+ hardDeleted?: SiteHardDeleted;
5507
+ /** Emitted on a namespace change. */
5508
+ namespaceChanged?: NamespaceChanged;
5509
+ /** Emitted when Studio is attached. */
5510
+ studioAssigned?: StudioAssigned;
5511
+ /** Emitted when Studio is detached. */
5512
+ studioUnassigned?: StudioUnassigned;
5614
5513
  /**
5615
- * Membership ID.
5616
- * @maxLength 200
5514
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5515
+ * the actual URL.
5516
+ *
5517
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5518
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5617
5519
  */
5618
- membershipId?: string;
5520
+ urlChanged?: SiteUrlChanged;
5521
+ /** Site is marked as PurgedExternally */
5522
+ sitePurgedExternally?: SitePurgedExternally;
5523
+ /** Emitted when Odeditor is attached. */
5524
+ odeditorAssigned?: OdeditorAssigned;
5525
+ /** Emitted when Odeditor is detached. */
5526
+ odeditorUnassigned?: OdeditorUnassigned;
5527
+ /** Emitted when Picasso is attached. */
5528
+ picassoAssigned?: PicassoAssigned;
5529
+ /** Emitted when Picasso is detached. */
5530
+ picassoUnassigned?: PicassoUnassigned;
5531
+ /** Emitted when Wixel is attached. */
5532
+ wixelAssigned?: WixelAssigned;
5533
+ /** Emitted when Wixel is detached. */
5534
+ wixelUnassigned?: WixelUnassigned;
5535
+ /** Emitted when StudioTwo is attached. */
5536
+ studioTwoAssigned?: StudioTwoAssigned;
5537
+ /** Emitted when StudioTwo is detached. */
5538
+ studioTwoUnassigned?: StudioTwoUnassigned;
5539
+ /** Emitted when media from user domain is enabled. */
5540
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5541
+ /** Emitted when media from user domain is disabled. */
5542
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5543
+ /** Emitted when Editorless is attached. */
5544
+ editorlessAssigned?: EditorlessAssigned;
5545
+ /** Emitted when Editorless is detached. */
5546
+ editorlessUnassigned?: EditorlessUnassigned;
5619
5547
  /**
5620
- * ID of the line item this membership applies to.
5621
- * @minLength 1
5622
- * @maxLength 100
5548
+ * A meta site id.
5549
+ * @format GUID
5623
5550
  */
5624
- lineItemId?: string;
5551
+ metaSiteId?: string;
5552
+ /** A meta site version. Monotonically increasing. */
5553
+ version?: string;
5554
+ /** A timestamp of the event. */
5555
+ timestamp?: string;
5625
5556
  /**
5626
- * Payment status.
5627
- * @deprecated Payment status.
5628
- * @replacedBy payment.status
5629
- * @targetRemovalDate 2026-11-01
5557
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5558
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5559
+ * @maxSize 4000
5630
5560
  */
5631
- status?: MembershipPaymentStatusWithLiterals;
5632
- /** Membership name. */
5633
- name?: MembershipName;
5561
+ assets?: Asset[];
5562
+ }
5563
+ /** @oneof */
5564
+ interface MetaSiteSpecialEventPayloadOneOf {
5565
+ /** Emitted on a meta site creation. */
5566
+ siteCreated?: SiteCreated;
5567
+ /** Emitted on a meta site transfer completion. */
5568
+ siteTransferred?: SiteTransferred;
5569
+ /** Emitted on a meta site deletion. */
5570
+ siteDeleted?: SiteDeleted;
5571
+ /** Emitted on a meta site restoration. */
5572
+ siteUndeleted?: SiteUndeleted;
5573
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5574
+ sitePublished?: SitePublished;
5575
+ /** Emitted on a meta site unpublish. */
5576
+ siteUnpublished?: SiteUnpublished;
5577
+ /** Emitted when meta site is marked as template. */
5578
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5579
+ /** Emitted when meta site is marked as a WixSite. */
5580
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5581
+ /** Emitted when an application is provisioned (installed). */
5582
+ serviceProvisioned?: ServiceProvisioned;
5583
+ /** Emitted when an application is removed (uninstalled). */
5584
+ serviceRemoved?: ServiceRemoved;
5585
+ /** Emitted when meta site name (URL slug) is changed. */
5586
+ siteRenamedPayload?: SiteRenamed;
5587
+ /** Emitted when meta site was permanently deleted. */
5588
+ hardDeleted?: SiteHardDeleted;
5589
+ /** Emitted on a namespace change. */
5590
+ namespaceChanged?: NamespaceChanged;
5591
+ /** Emitted when Studio is attached. */
5592
+ studioAssigned?: StudioAssigned;
5593
+ /** Emitted when Studio is detached. */
5594
+ studioUnassigned?: StudioUnassigned;
5634
5595
  /**
5635
- * The transaction ID in the membership system. Can be used to void the transaction.
5636
- * @minLength 1
5637
- * @maxLength 100
5596
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5597
+ * the actual URL.
5598
+ *
5599
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5600
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5638
5601
  */
5639
- externalTransactionId?: string | null;
5602
+ urlChanged?: SiteUrlChanged;
5603
+ /** Site is marked as PurgedExternally */
5604
+ sitePurgedExternally?: SitePurgedExternally;
5605
+ /** Emitted when Odeditor is attached. */
5606
+ odeditorAssigned?: OdeditorAssigned;
5607
+ /** Emitted when Odeditor is detached. */
5608
+ odeditorUnassigned?: OdeditorUnassigned;
5609
+ /** Emitted when Picasso is attached. */
5610
+ picassoAssigned?: PicassoAssigned;
5611
+ /** Emitted when Picasso is detached. */
5612
+ picassoUnassigned?: PicassoUnassigned;
5613
+ /** Emitted when Wixel is attached. */
5614
+ wixelAssigned?: WixelAssigned;
5615
+ /** Emitted when Wixel is detached. */
5616
+ wixelUnassigned?: WixelUnassigned;
5617
+ /** Emitted when StudioTwo is attached. */
5618
+ studioTwoAssigned?: StudioTwoAssigned;
5619
+ /** Emitted when StudioTwo is detached. */
5620
+ studioTwoUnassigned?: StudioTwoUnassigned;
5621
+ /** Emitted when media from user domain is enabled. */
5622
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5623
+ /** Emitted when media from user domain is disabled. */
5624
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5625
+ /** Emitted when Editorless is attached. */
5626
+ editorlessAssigned?: EditorlessAssigned;
5627
+ /** Emitted when Editorless is detached. */
5628
+ editorlessUnassigned?: EditorlessUnassigned;
5629
+ }
5630
+ interface Asset {
5640
5631
  /**
5641
- * Whether the membership is voided.
5642
- * @readonly
5643
- * @deprecated Whether the membership is voided.
5644
- * @replacedBy payment.status
5645
- * @targetRemovalDate 2026-11-01
5632
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5633
+ * @maxLength 36
5646
5634
  */
5647
- voided?: boolean;
5635
+ appDefId?: string;
5648
5636
  /**
5649
- * ID of the application providing this payment option.
5650
- * @format GUID
5637
+ * An instance id. For legacy reasons may be UUID or a string.
5638
+ * @maxLength 200
5651
5639
  */
5652
- providerAppId?: string;
5653
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5654
- futureMembership?: FutureMembershipDetails;
5640
+ instanceId?: string;
5641
+ /** An application state. */
5642
+ state?: StateWithLiterals;
5655
5643
  }
5656
- declare enum MembershipPaymentStatus {
5657
- /** Payment was charged. */
5658
- CHARGED = "CHARGED",
5659
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5660
- CHARGE_FAILED = "CHARGE_FAILED",
5661
- /** Payment is pending. */
5662
- CHARGE_PENDING = "CHARGE_PENDING",
5663
- /** Payment was voided. */
5664
- VOIDED = "VOIDED"
5644
+ declare enum State {
5645
+ UNKNOWN = "UNKNOWN",
5646
+ ENABLED = "ENABLED",
5647
+ DISABLED = "DISABLED",
5648
+ PENDING = "PENDING",
5649
+ DEMO = "DEMO"
5665
5650
  }
5666
5651
  /** @enumType */
5667
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5668
- interface FutureMembershipDetails {
5652
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5653
+ interface SiteCreated {
5669
5654
  /**
5670
- * ID of the plan line item in the order from which the membership will be created.
5671
- * @format GUID
5655
+ * A template identifier (empty if not created from a template).
5656
+ * @maxLength 36
5672
5657
  */
5673
- lineItemId?: string;
5658
+ originTemplateId?: string;
5674
5659
  /**
5675
- * ID of the benefit the future membership will grant.
5676
- * @maxLength 200
5660
+ * An account id of the owner.
5661
+ * @format GUID
5677
5662
  */
5678
- benefitId?: string;
5679
- }
5680
- interface WixReceiptInfo {
5663
+ ownerId?: string;
5664
+ /** A context in which meta site was created. */
5665
+ context?: SiteCreatedContextWithLiterals;
5681
5666
  /**
5682
- * Receipt ID
5667
+ * A meta site id from which this site was created.
5668
+ *
5669
+ * In case of a creation from a template it's a template id.
5670
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5683
5671
  * @format GUID
5684
5672
  */
5685
- receiptId?: string;
5673
+ originMetaSiteId?: string | null;
5686
5674
  /**
5687
- * Display number of receipt
5688
- * @minLength 1
5689
- * @maxLength 40
5675
+ * A meta site name (URL slug).
5676
+ * @maxLength 20
5690
5677
  */
5691
- displayNumber?: string | null;
5678
+ siteName?: string;
5679
+ /** A namespace. */
5680
+ namespace?: NamespaceWithLiterals;
5692
5681
  }
5693
- interface ExternalReceiptInfo {
5682
+ declare enum SiteCreatedContext {
5683
+ /** A valid option, we don't expose all reasons why site might be created. */
5684
+ OTHER = "OTHER",
5685
+ /** A meta site was created from template. */
5686
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5687
+ /** A meta site was created by copying of the transfferred meta site. */
5688
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5689
+ /** A copy of existing meta site. */
5690
+ DUPLICATE = "DUPLICATE",
5691
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5692
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5693
+ /** deprecated A meta site was created for Flash editor. */
5694
+ FLASH = "FLASH"
5695
+ }
5696
+ /** @enumType */
5697
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5698
+ declare enum Namespace {
5699
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5700
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5701
+ WIX = "WIX",
5702
+ /** 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. */
5703
+ SHOUT_OUT = "SHOUT_OUT",
5704
+ /** 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. */
5705
+ ALBUMS = "ALBUMS",
5706
+ /** 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. */
5707
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5708
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5709
+ HOTELS = "HOTELS",
5710
+ /** 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. */
5711
+ CLUBS = "CLUBS",
5712
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5713
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5694
5714
  /**
5695
- * External receipt ID
5696
- * @maxLength 100
5715
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5716
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5697
5717
  */
5698
- receiptId?: string | null;
5718
+ DEV_SITE = "DEV_SITE",
5719
+ /** 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. */
5720
+ LOGOS = "LOGOS",
5721
+ /** 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. */
5722
+ VIDEO_MAKER = "VIDEO_MAKER",
5723
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5724
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5725
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5726
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5699
5727
  /**
5700
- * ID of the app providing the receipt
5701
- * @format GUID
5728
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5729
+ *
5730
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5702
5731
  */
5703
- appId?: string | null;
5732
+ HTML_DRAFT = "HTML_DRAFT",
5704
5733
  /**
5705
- * Display number of receipt
5706
- * @minLength 1
5707
- * @maxLength 40
5734
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5735
+ * Will be accessible from Site List and will not have a website app.
5736
+ * Once the user attaches a site, the site will become a regular wixsite.
5708
5737
  */
5709
- displayNumber?: string | null;
5710
- }
5711
- interface CashRoundingDetails {
5738
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5739
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5740
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5741
+ /** It is to be used in the Business First efforts. */
5742
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5743
+ /** Bookings business flow with no site. */
5744
+ ANYWHERE = "ANYWHERE",
5745
+ /** Namespace for Headless Backoffice with no editor */
5746
+ HEADLESS = "HEADLESS",
5712
5747
  /**
5713
- * Payment amount before cash rounding was applied.
5714
- * When provided, balance and status calculations use this value instead of `amount`
5715
- * to prevent false overpayment or underpayment due to rounding.
5748
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5749
+ * The site will be used for account level CSM feature for enterprise
5716
5750
  */
5717
- unroundedAmount?: Price;
5751
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5752
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5753
+ RISE = "RISE",
5718
5754
  /**
5719
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5720
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5721
- * @readonly
5755
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5756
+ * There's a blank site behind the scene but it's blank).
5757
+ * The Mobile company will be the owner of this namespace.
5722
5758
  */
5723
- roundingAdjustment?: CashRounding;
5724
- }
5725
- declare enum PaymentStatus {
5726
- /** Payment was charged successfully. */
5727
- APPROVED = "APPROVED",
5728
- /** Payment is being processed and hasn't been confirmed yet. */
5729
- PENDING = "PENDING",
5730
- /** 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. */
5731
- PENDING_MERCHANT = "PENDING_MERCHANT",
5732
- /** Payment was canceled before it was charged. */
5733
- CANCELED = "CANCELED",
5734
- /** Payment was declined by the payment provider. */
5735
- DECLINED = "DECLINED",
5736
- /** Payment was fully refunded. */
5737
- REFUNDED = "REFUNDED",
5738
- /** Part of the payment amount was refunded. */
5739
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5740
- /** 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. */
5741
- AUTHORIZED = "AUTHORIZED",
5759
+ BRANDED_FIRST = "BRANDED_FIRST",
5760
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5761
+ NOWNIA = "NOWNIA",
5742
5762
  /**
5743
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5744
- *
5745
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5763
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5764
+ * The Partners company owns this namespace.
5746
5765
  */
5747
- VOIDED = "VOIDED"
5748
- }
5749
- /** @enumType */
5750
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5751
- interface CanceledStatusDetails {
5752
- reason?: CanceledReasonWithLiterals;
5753
- }
5754
- declare enum CanceledReason {
5755
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5756
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5757
- /** Payment was not completed by user and expired. */
5758
- EXPIRED = "EXPIRED"
5759
- }
5760
- /** @enumType */
5761
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5762
- interface DeclinedStatusDetails {
5763
- reason?: DeclinedReasonWithLiterals;
5764
- }
5765
- declare enum DeclinedReason {
5766
- /** Corresponding charge failed. */
5767
- CHARGE_FAILED = "CHARGE_FAILED",
5768
- /** Payment details expired. */
5769
- EXPIRED = "EXPIRED",
5770
- /** Insufficient funds. */
5771
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5772
- /** Gift card was disabled before charge was attempted. */
5773
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5774
- }
5775
- /** @enumType */
5776
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5777
- interface VoidedStatusDetails {
5778
- reason?: VoidedReasonWithLiterals;
5779
- }
5780
- declare enum VoidedReason {
5781
- /** Payment was voided by merchant request. */
5782
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5783
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5784
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5785
- }
5786
- /** @enumType */
5787
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5788
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5789
- }
5790
- /** @oneof */
5791
- interface PaymentStatusDetailsStatusDetailsOneOf {
5792
- }
5793
- interface Refund {
5766
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5767
+ /** Codux Headless Sites */
5768
+ CODUX = "CODUX",
5769
+ /** Bobb - AI Design Creator. */
5770
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5794
5771
  /**
5795
- * Refund ID.
5796
- * @format GUID
5797
- * @readonly
5772
+ * Shared Blog Site is a unique single site across Enterprise account,
5773
+ * This site will hold all Blog posts related to the Marketing product.
5798
5774
  */
5799
- _id?: string;
5775
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5776
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5777
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5778
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5779
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5780
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5781
+ MIMIR = "MIMIR",
5782
+ /** Wix Twins platform. */
5783
+ TWINS = "TWINS",
5784
+ /** Wix Nano. */
5785
+ NANO = "NANO",
5786
+ /** Base44 headless sites. */
5787
+ BASE44 = "BASE44",
5788
+ /** Wix Channels Sites */
5789
+ CHANNELS = "CHANNELS",
5790
+ /** Nautilus platform. */
5791
+ NAUTILUS = "NAUTILUS",
5800
5792
  /**
5801
- * List of transactions.
5802
- * @maxSize 50
5793
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5794
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5803
5795
  */
5804
- transactions?: RefundTransaction[];
5805
- /** Refund business details. */
5806
- details?: RefundDetails;
5796
+ SYMPHONY = "SYMPHONY",
5797
+ /** Nautilus platform app. */
5798
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5807
5799
  /**
5808
- * 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.
5809
- * @readonly
5810
- * @immutable
5800
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5801
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5811
5802
  */
5812
- _createdDate?: Date | null;
5803
+ VIBU = "VIBU",
5813
5804
  /**
5814
- * Aggregated refund summary.
5815
- * @readonly
5805
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5806
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5807
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5808
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5816
5809
  */
5817
- summary?: AggregatedRefundSummary;
5810
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5818
5811
  /**
5819
- * ID of the app that initiated this refund.
5820
- * @format GUID
5821
- * @readonly
5822
- * @immutable
5812
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5813
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5823
5814
  */
5824
- requestingServiceAppId?: string | null;
5815
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5825
5816
  }
5826
- interface RefundTransaction {
5817
+ /** @enumType */
5818
+ 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';
5819
+ /** Site transferred to another user. */
5820
+ interface SiteTransferred {
5827
5821
  /**
5828
- * ID of the payment associated with this refund.
5822
+ * A previous owner id (user that transfers meta site).
5829
5823
  * @format GUID
5830
- * @immutable
5831
5824
  */
5832
- paymentId?: string;
5825
+ oldOwnerId?: string;
5833
5826
  /**
5834
- * Refund amount.
5835
- * @immutable
5827
+ * A new owner id (user that accepts meta site).
5828
+ * @format GUID
5836
5829
  */
5837
- amount?: Price;
5838
- /** Refund status. */
5839
- refundStatus?: RefundStatusWithLiterals;
5840
- /** Optional details of current refund status. */
5841
- refundStatusInfo?: RefundStatusInfo;
5830
+ newOwnerId?: string;
5831
+ }
5832
+ /** Soft deletion of the meta site. Could be restored. */
5833
+ interface SiteDeleted {
5834
+ /** A deletion context. */
5835
+ deleteContext?: DeleteContext;
5836
+ }
5837
+ interface DeleteContext {
5838
+ /** When the meta site was deleted. */
5839
+ dateDeleted?: Date | null;
5840
+ /** A status. */
5841
+ deleteStatus?: DeleteStatusWithLiterals;
5842
5842
  /**
5843
- * Payment gateway's refund ID.
5844
- * This field is only returned when the value of `external_refund` is `false`.
5845
- * @format GUID
5843
+ * A reason (flow).
5844
+ * @maxLength 255
5846
5845
  */
5847
- gatewayRefundId?: string | null;
5848
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5849
- providerRefundId?: string | null;
5846
+ deleteOrigin?: string;
5850
5847
  /**
5851
- * Whether refund was made externally and manually on the payment provider's side.
5852
- * @immutable
5848
+ * A service that deleted it.
5849
+ * @maxLength 255
5853
5850
  */
5854
- externalRefund?: boolean;
5851
+ initiatorId?: string | null;
5855
5852
  }
5856
- /** Refund transaction status. */
5857
- declare enum RefundStatus {
5858
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5859
- PENDING = "PENDING",
5860
- /** Refund transaction succeeded. */
5861
- SUCCEEDED = "SUCCEEDED",
5862
- /** Refund transaction failed. */
5863
- FAILED = "FAILED",
5864
- /** Refund request acknowledged, and will be executed soon. */
5865
- SCHEDULED = "SCHEDULED",
5866
- /** Refund was initiated on payment provider side. */
5867
- STARTED = "STARTED"
5853
+ declare enum DeleteStatus {
5854
+ UNKNOWN = "UNKNOWN",
5855
+ TRASH = "TRASH",
5856
+ DELETED = "DELETED",
5857
+ PENDING_PURGE = "PENDING_PURGE",
5858
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5868
5859
  }
5869
5860
  /** @enumType */
5870
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5871
- interface RefundStatusInfo {
5872
- /**
5873
- * Reason code for the refund's current status.
5874
- *
5875
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5876
- * @minLength 1
5877
- * @maxLength 10
5878
- */
5879
- paymentGatewayReasonCode?: string | null;
5861
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5862
+ /** Restoration of the meta site. */
5863
+ interface SiteUndeleted {
5864
+ }
5865
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5866
+ interface SitePublished {
5867
+ }
5868
+ interface SiteUnpublished {
5880
5869
  /**
5881
- * Free text explanation of current refund status.
5882
- * @minLength 1
5883
- * @maxLength 1000
5870
+ * A list of URLs previously associated with the meta site.
5871
+ * @maxLength 4000
5872
+ * @maxSize 10000
5884
5873
  */
5885
- description?: string | null;
5874
+ urls?: string[];
5886
5875
  }
5887
- interface AggregatedRefundSummary {
5888
- /** Total amount requested for refund. */
5889
- requestedRefund?: Price;
5890
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5891
- pendingRefund?: Price;
5892
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5893
- refunded?: Price;
5894
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5895
- failedRefundAmount?: Price;
5896
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5897
- pending?: boolean;
5898
- /** Breakdown of refunded items. Available only after refund is complete. */
5899
- breakdown?: RefundItemsBreakdown;
5876
+ interface SiteMarkedAsTemplate {
5900
5877
  }
5901
- interface RefundItemsBreakdown {
5878
+ interface SiteMarkedAsWixSite {
5879
+ }
5880
+ /**
5881
+ * Represents a service provisioned a site.
5882
+ *
5883
+ * Note on `origin_instance_id`:
5884
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5885
+ * This is because of the following scenario:
5886
+ *
5887
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5888
+ * such as a product catalog. When you create a site from this template, you inherit this
5889
+ * default product catalog. However, if the template's product catalog is modified,
5890
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5891
+ * your site remains consistent with what you initially received and does not include any
5892
+ * changes made to the original template afterward.
5893
+ * To ensure this, the TPA on the template gets a new instance_id.
5894
+ */
5895
+ interface ServiceProvisioned {
5902
5896
  /**
5903
- * Refunded line items and the amount refunded for each.
5904
- * @maxSize 300
5897
+ * Either UUID or EmbeddedServiceType.
5898
+ * @maxLength 36
5905
5899
  */
5906
- lineItems?: LineItemRefundSummary[];
5907
- }
5908
- interface LineItemRefundSummary {
5900
+ appDefId?: string;
5909
5901
  /**
5910
- * ID of the refunded line item.
5911
- * @format GUID
5902
+ * Not only UUID. Something here could be something weird.
5903
+ * @maxLength 36
5912
5904
  */
5913
- lineItemId?: string;
5914
- /** Total refunded amount for the line item. */
5915
- totalRefundedAmount?: Price;
5916
- }
5917
- interface CalculateRefundRequest {
5905
+ instanceId?: string;
5918
5906
  /**
5919
- * Order ID
5920
- * @minLength 1
5921
- * @maxLength 100
5907
+ * An instance id from which this instance is originated.
5908
+ * @maxLength 36
5922
5909
  */
5923
- ecomOrderId?: string;
5910
+ originInstanceId?: string;
5924
5911
  /**
5925
- * Refunded line items and quantity
5926
- * @maxSize 300
5912
+ * A version.
5913
+ * @maxLength 500
5927
5914
  */
5928
- refundItems?: CalculateRefundItemRequest[];
5929
- /** Should include shipping in refund calculation */
5930
- refundShipping?: boolean;
5931
- }
5932
- interface CalculateRefundItemRequest {
5915
+ version?: string | null;
5933
5916
  /**
5934
- * ID of the line item being refunded
5917
+ * The origin meta site id
5935
5918
  * @format GUID
5936
5919
  */
5937
- _id?: string;
5920
+ originMetaSiteId?: string | null;
5921
+ }
5922
+ interface ServiceRemoved {
5938
5923
  /**
5939
- * How much of that line item is being refunded
5940
- * @min 1
5941
- * @max 100000
5924
+ * Either UUID or EmbeddedServiceType.
5925
+ * @maxLength 36
5942
5926
  */
5943
- quantity?: number;
5944
- }
5945
- interface CalculateRefundResponse {
5946
- /** Total refundable amount */
5947
- total?: Price;
5948
- /** Tax cost of the order */
5949
- tax?: Price;
5950
- /** Discount given for this order */
5951
- discount?: Price;
5952
- /** Total cost of the order (without tax) */
5953
- subtotal?: Price;
5954
- /** Total shipping cost for order */
5955
- shipping?: Price;
5956
- /** Previous refund given on that order */
5957
- previouslyRefundedAmount?: Price;
5927
+ appDefId?: string;
5958
5928
  /**
5959
- * The refundable items of that order
5960
- * @maxSize 300
5929
+ * Not only UUID. Something here could be something weird.
5930
+ * @maxLength 36
5961
5931
  */
5962
- items?: CalculateRefundItemResponse[];
5963
- }
5964
- interface CalculateRefundItemResponse {
5932
+ instanceId?: string;
5965
5933
  /**
5966
- * Line item ID
5967
- * @format GUID
5934
+ * A version.
5935
+ * @maxLength 500
5968
5936
  */
5969
- _id?: string;
5970
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5971
- price?: Price;
5937
+ version?: string | null;
5972
5938
  }
5973
- interface VoidAuthorizedPaymentsRequest {
5939
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5940
+ interface SiteRenamed {
5974
5941
  /**
5975
- * Wix eCommerce order ID
5976
- * @minLength 1
5977
- * @maxLength 100
5942
+ * A new meta site name (URL slug).
5943
+ * @maxLength 20
5978
5944
  */
5979
- ecomOrderId: string;
5945
+ newSiteName?: string;
5980
5946
  /**
5981
- * Payment IDs
5982
- * @minSize 1
5983
- * @maxSize 100
5984
- * @format GUID
5947
+ * A previous meta site name (URL slug).
5948
+ * @maxLength 255
5985
5949
  */
5986
- paymentIds: string[];
5950
+ oldSiteName?: string;
5987
5951
  }
5988
- interface VoidAuthorizedPaymentsResponse {
5989
- /** All order's transactions after the void was triggered */
5990
- orderTransactions?: OrderTransactions;
5952
+ /**
5953
+ * Hard deletion of the meta site.
5954
+ *
5955
+ * Could not be restored. Therefore it's desirable to cleanup data.
5956
+ */
5957
+ interface SiteHardDeleted {
5958
+ /** A deletion context. */
5959
+ deleteContext?: DeleteContext;
5991
5960
  }
5992
- interface CaptureAuthorizedPaymentsRequest {
5993
- /**
5994
- * Wix eCommerce order ID
5995
- * @minLength 1
5996
- * @maxLength 100
5997
- */
5998
- ecomOrderId: string;
5961
+ interface NamespaceChanged {
5962
+ /** A previous namespace. */
5963
+ oldNamespace?: NamespaceWithLiterals;
5964
+ /** A new namespace. */
5965
+ newNamespace?: NamespaceWithLiterals;
5966
+ }
5967
+ /** Assigned Studio editor */
5968
+ interface StudioAssigned {
5969
+ }
5970
+ /** Unassigned Studio editor */
5971
+ interface StudioUnassigned {
5972
+ }
5973
+ /**
5974
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5975
+ *
5976
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5977
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5978
+ *
5979
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5980
+ */
5981
+ interface SiteUrlChanged {
5982
+ }
5983
+ /**
5984
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5985
+ * Consumed by other teams to remove relevant data.
5986
+ */
5987
+ interface SitePurgedExternally {
5999
5988
  /**
6000
- * Capture payments information
6001
- * @minSize 1
5989
+ * @maxLength 2048
6002
5990
  * @maxSize 100
5991
+ * @deprecated
5992
+ * @targetRemovalDate 2025-04-15
6003
5993
  */
6004
- payments: PaymentCapture[];
5994
+ appDefId?: string[];
6005
5995
  }
6006
- interface PaymentCapture {
6007
- /**
6008
- * Payment ID
6009
- * @format GUID
6010
- */
6011
- paymentId?: string | null;
6012
- /**
6013
- * Capture amount.
6014
- * If not provided - full authorized amount will be captured.
6015
- */
6016
- amount?: Price;
5996
+ /** Assigned Odeditor */
5997
+ interface OdeditorAssigned {
6017
5998
  }
6018
- interface CaptureAuthorizedPaymentsResponse {
6019
- /** All order's transactions after the capture was triggered */
6020
- orderTransactions?: OrderTransactions;
5999
+ /** Unassigned Odeditor */
6000
+ interface OdeditorUnassigned {
6021
6001
  }
6022
- interface ChargeSavedPaymentMethodRequest {
6023
- /**
6024
- * Ecom Order ID.
6025
- * @minLength 1
6026
- * @maxLength 100
6027
- */
6028
- ecomOrderId?: string;
6029
- /** Amount to be charged */
6030
- amount?: Price;
6002
+ /** Assigned Picasso editor */
6003
+ interface PicassoAssigned {
6031
6004
  }
6032
- interface ChargeSavedPaymentMethodResponse {
6033
- /** Payment gateway's order ID (e.g Wix Payments) */
6034
- paymentGatewayOrderId?: string;
6005
+ /** Unassigned Picasso */
6006
+ interface PicassoUnassigned {
6035
6007
  }
6036
- interface V1TriggerReindexRequest {
6037
- /** @format GUID */
6038
- metasiteId?: string;
6039
- /**
6040
- * @minLength 1
6041
- * @maxLength 100
6042
- * @maxSize 100
6043
- */
6044
- orderIds?: string[];
6008
+ /** Assigned Wixel */
6009
+ interface WixelAssigned {
6045
6010
  }
6046
- interface V1TriggerReindexResponse {
6011
+ /** Unassigned Wixel */
6012
+ interface WixelUnassigned {
6047
6013
  }
6048
- interface V1TriggerReindexOrderRequest {
6049
- /** @format GUID */
6050
- metasiteId?: string;
6051
- /**
6052
- * @minLength 1
6053
- * @maxLength 100
6054
- */
6055
- orderId?: string;
6014
+ /** Assigned StudioTwo */
6015
+ interface StudioTwoAssigned {
6016
+ }
6017
+ /** Unassigned StudioTwo */
6018
+ interface StudioTwoUnassigned {
6019
+ }
6020
+ /** Media from user domain is enabled. */
6021
+ interface UserDomainMediaEnabled {
6022
+ }
6023
+ /** Media from user domain is disabled. */
6024
+ interface UserDomainMediaDisabled {
6025
+ }
6026
+ /** Assigned Editorless */
6027
+ interface EditorlessAssigned {
6028
+ }
6029
+ /** Unassigned Editorless */
6030
+ interface EditorlessUnassigned {
6031
+ }
6032
+ interface HasCustomEmailConfigurationsRequest {
6033
+ }
6034
+ interface HasCustomEmailConfigurationsResponse {
6035
+ hasCustomConfigurations?: boolean;
6036
+ }
6037
+ interface AddToAutomationMigrationPopulationRequest {
6038
+ /** When true, sends custom email configurations to automation system via email */
6039
+ sendCustomEmailConfigs?: boolean;
6040
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6041
+ origin?: OriginWithLiterals;
6042
+ }
6043
+ declare enum Origin {
6044
+ OPT_IN = "OPT_IN",
6045
+ MIGRATION = "MIGRATION"
6046
+ }
6047
+ /** @enumType */
6048
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6049
+ interface AddToAutomationMigrationPopulationResponse {
6050
+ success?: boolean;
6051
+ }
6052
+ interface IsInAutomationMigrationPopulationRequest {
6053
+ }
6054
+ interface IsInAutomationMigrationPopulationResponse {
6055
+ inPopulation?: boolean;
6056
6056
  }
6057
6057
  interface DiffmatokyPayload {
6058
6058
  left?: string;
@@ -8382,7 +8382,7 @@ declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void |
8382
8382
  * @applicableIdentity APP
8383
8383
  * @fqn com.wix.ecom.orders.importer.v1.OrderImports.ImportOrder
8384
8384
  */
8385
- declare function importOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `paymentStatus` | `priceSummary` | `status`, 5>): Promise<NonNullablePaths<ImportOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported`, 7> & {
8385
+ declare function importOrder(order: NonNullablePaths<Order, `billingInfo.contactDetails` | `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `paymentStatus` | `priceSummary` | `status`, 3>): Promise<NonNullablePaths<ImportOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported`, 5> & {
8386
8386
  __applicationErrorsType?: ImportOrderApplicationErrors;
8387
8387
  }>;
8388
8388
  /**
@@ -8401,7 +8401,7 @@ declare function importOrder(order: NonNullablePaths<Order, `billingInfo.contact
8401
8401
  * @applicableIdentity APP
8402
8402
  * @fqn com.wix.ecom.orders.importer.v1.OrderImports.SetOrderNumberCounter
8403
8403
  */
8404
- declare function setOrderNumberCounter(counter: string, options?: SetOrderNumberCounterOptions): Promise<NonNullablePaths<SetOrderNumberCounterResponse, `oldCounter` | `newCounter`, 2> & {
8404
+ declare function setOrderNumberCounter(counter: string, options?: SetOrderNumberCounterOptions): Promise<NonNullablePaths<SetOrderNumberCounterResponse, `oldCounter` | `newCounter`, 0> & {
8405
8405
  __applicationErrorsType?: SetOrderNumberCounterApplicationErrors;
8406
8406
  }>;
8407
8407
  interface SetOrderNumberCounterOptions {
@@ -8428,7 +8428,7 @@ interface SetOrderNumberCounterOptions {
8428
8428
  * @applicableIdentity APP
8429
8429
  * @fqn com.wix.ecom.orders.importer.v1.OrderImports.BulkDeleteImportedOrders
8430
8430
  */
8431
- declare function bulkDeleteImportedOrders(orderIds: string[]): Promise<NonNullablePaths<BulkDeleteImportedOrdersResponse, `jobId`, 2>>;
8431
+ declare function bulkDeleteImportedOrders(orderIds: string[]): Promise<NonNullablePaths<BulkDeleteImportedOrdersResponse, `jobId`, 0>>;
8432
8432
  /**
8433
8433
  * Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
8434
8434
  * Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
@@ -8445,7 +8445,7 @@ declare function bulkDeleteImportedOrders(orderIds: string[]): Promise<NonNullab
8445
8445
  * @applicableIdentity APP
8446
8446
  * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
8447
8447
  */
8448
- declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`, 2> & {
8448
+ declare function preparePaymentCollection(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions): Promise<NonNullablePaths<PreparePaymentCollectionResponse, `paymentGatewayOrderId`, 0> & {
8449
8449
  __applicationErrorsType?: PreparePaymentCollectionApplicationErrors;
8450
8450
  }>;
8451
8451
  interface PreparePaymentCollectionOptions {
@@ -8479,7 +8479,7 @@ interface PreparePaymentCollectionOptions {
8479
8479
  * @applicableIdentity APP
8480
8480
  * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
8481
8481
  */
8482
- declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`, 3>>;
8482
+ declare function getPaymentCollectabilityStatus(ecomOrderId: string): Promise<NonNullablePaths<GetPaymentCollectabilityStatusResponse, `status` | `amount.amount` | `amount.formattedAmount`, 1>>;
8483
8483
  interface RecordManuallyCollectedPaymentOptions {
8484
8484
  }
8485
8485
  interface PaymentCollectionMarkOrderAsPaidOptions {
@@ -8515,7 +8515,7 @@ interface TriggerRefundOptions {
8515
8515
  * @applicableIdentity APP
8516
8516
  * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
8517
8517
  */
8518
- declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.membershipId` | `orderTransactions.payments.${number}.membershipPaymentDetails.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.status` | `orderTransactions.payments.${number}.membershipPaymentDetails.name.original` | `orderTransactions.payments.${number}.membershipPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.providerAppId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.benefitId` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.supportReceiptGeneration` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.payments.${number}.status` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 7> & {
8518
+ declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[]): Promise<NonNullablePaths<VoidAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.membershipId` | `orderTransactions.payments.${number}.membershipPaymentDetails.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.status` | `orderTransactions.payments.${number}.membershipPaymentDetails.name.original` | `orderTransactions.payments.${number}.membershipPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.providerAppId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.benefitId` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.supportReceiptGeneration` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.payments.${number}.status` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 5> & {
8519
8519
  __applicationErrorsType?: VoidAuthorizedPaymentsApplicationErrors;
8520
8520
  }>;
8521
8521
  /**
@@ -8532,7 +8532,7 @@ declare function voidAuthorizedPayments(ecomOrderId: string, paymentIds: string[
8532
8532
  * @applicableIdentity APP
8533
8533
  * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
8534
8534
  */
8535
- declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`, 2>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.membershipId` | `orderTransactions.payments.${number}.membershipPaymentDetails.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.status` | `orderTransactions.payments.${number}.membershipPaymentDetails.name.original` | `orderTransactions.payments.${number}.membershipPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.providerAppId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.benefitId` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.supportReceiptGeneration` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.payments.${number}.status` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 7> & {
8535
+ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNullablePaths<PaymentCapture, `paymentId`, 0>[]): Promise<NonNullablePaths<CaptureAuthorizedPaymentsResponse, `orderTransactions.orderId` | `orderTransactions.payments` | `orderTransactions.payments.${number}.regularPaymentDetails.offlinePayment` | `orderTransactions.payments.${number}.regularPaymentDetails.status` | `orderTransactions.payments.${number}.regularPaymentDetails.savedPaymentMethod` | `orderTransactions.payments.${number}.regularPaymentDetails.authorizationDetails.delayedCapture` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.amount` | `orderTransactions.payments.${number}.regularPaymentDetails.platformFee.formattedAmount` | `orderTransactions.payments.${number}.giftcardPaymentDetails.giftCardPaymentId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.appId` | `orderTransactions.payments.${number}.giftcardPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.membershipId` | `orderTransactions.payments.${number}.membershipPaymentDetails.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.status` | `orderTransactions.payments.${number}.membershipPaymentDetails.name.original` | `orderTransactions.payments.${number}.membershipPaymentDetails.voided` | `orderTransactions.payments.${number}.membershipPaymentDetails.providerAppId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.lineItemId` | `orderTransactions.payments.${number}.membershipPaymentDetails.futureMembership.benefitId` | `orderTransactions.payments.${number}.refundDisabled` | `orderTransactions.payments.${number}.supportReceiptGeneration` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.amount` | `orderTransactions.payments.${number}.cashRounding.roundingAdjustment.formattedAmount` | `orderTransactions.payments.${number}.status` | `orderTransactions.refunds` | `orderTransactions.refunds.${number}._id` | `orderTransactions.refunds.${number}.details.shippingIncluded` | `orderTransactions.refunds.${number}.summary.pending`, 5> & {
8536
8536
  __applicationErrorsType?: CaptureAuthorizedPaymentsApplicationErrors;
8537
8537
  }>;
8538
8538
  /**
@@ -8551,7 +8551,7 @@ declare function captureAuthorizedPayments(ecomOrderId: string, payments: NonNul
8551
8551
  * @returns Fulfilled - The requested order.
8552
8552
  * @fqn com.wix.ecom.orders.v1.Orders.GetOrder
8553
8553
  */
8554
- declare function getOrder(_id: string): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 6> & {
8554
+ declare function getOrder(_id: string): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 4> & {
8555
8555
  __applicationErrorsType?: GetOrderApplicationErrors;
8556
8556
  }>;
8557
8557
  interface OrderSearchSpec extends SearchSpec {
@@ -8719,7 +8719,7 @@ declare const utils: {
8719
8719
  * @returns Newly created order.
8720
8720
  * @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
8721
8721
  */
8722
- declare function createOrder(order: NonNullablePaths<Order, `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`, 5>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 6> & {
8722
+ declare function createOrder(order: NonNullablePaths<Order, `channelInfo` | `currencyConversionDetails.conversionRate` | `currencyConversionDetails.originalCurrency` | `lineItems` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.itemType` | `lineItems.${number}.price` | `lineItems.${number}.productName` | `lineItems.${number}.productName.original` | `lineItems.${number}.quantity` | `priceSummary`, 3>, options?: CreateOrderOptions): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 4> & {
8723
8723
  __applicationErrorsType?: CreateOrderApplicationErrors;
8724
8724
  }>;
8725
8725
  interface CreateOrderOptions {
@@ -8762,7 +8762,7 @@ interface CreateOrderOptions {
8762
8762
  * @returns Newly created order.
8763
8763
  * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
8764
8764
  */
8765
- declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 6> & {
8765
+ declare function updateOrder(_id: string, order: UpdateOrder): Promise<NonNullablePaths<Order, `number` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `paymentStatus` | `fulfillmentStatus` | `weightUnit` | `taxIncludedInPrices` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `status` | `taxInfo.taxBreakdown` | `taxInfo.taxBreakdown.${number}.taxName` | `taxInfo.taxBreakdown.${number}.taxType` | `taxInfo.taxBreakdown.${number}.jurisdiction` | `taxInfo.taxBreakdown.${number}.jurisdictionType` | `taxInfo.taxBreakdown.${number}.rate` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `activities` | `activities.${number}.merchantComment.message` | `activities.${number}.orderRefunded.manual` | `activities.${number}.orderRefunded.reason` | `activities.${number}.draftOrderChangesApplied.draftOrderId` | `activities.${number}.savedPaymentMethod.name` | `activities.${number}.authorizedPaymentCreated.paymentId` | `activities.${number}.authorizedPaymentCaptured.paymentId` | `activities.${number}.authorizedPaymentVoided.paymentId` | `activities.${number}.refundInitiated.refundId` | `activities.${number}.paymentRefunded.refundId` | `activities.${number}.paymentRefundFailed.refundId` | `activities.${number}.paymentPending.paymentId` | `activities.${number}.paymentCanceled.paymentId` | `activities.${number}.paymentDeclined.paymentId` | `activities.${number}.receiptCreated.wixReceipt.receiptId` | `activities.${number}.receiptCreated.paymentId` | `activities.${number}.receiptSent.paymentId` | `activities.${number}.chargebackCreated.paymentId` | `activities.${number}.chargebackCreated.chargebackId` | `activities.${number}.chargebackReversed.paymentId` | `activities.${number}.chargebackReversed.chargebackId` | `activities.${number}.type` | `activities.${number}.activityType` | `attributionSource` | `createdBy.userId` | `createdBy.memberId` | `createdBy.visitorId` | `createdBy.appId` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `balanceSummary.balance.amount` | `balanceSummary.balance.formattedAmount` | `balanceSummary.cashRoundingAdjustment.amount` | `balanceSummary.cashRoundingAdjustment.formattedAmount` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `tags.privateTags.tagIds` | `businessLocation._id` | `businessLocation.name` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `imported`, 4> & {
8766
8766
  __applicationErrorsType?: UpdateOrderApplicationErrors;
8767
8767
  }>;
8768
8768
  interface UpdateOrder {
@@ -8999,7 +8999,7 @@ interface UpdateOrder {
8999
8999
  * @applicableIdentity APP
9000
9000
  * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
9001
9001
  */
9002
- declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`, 3>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.number` | `results.${number}.item.buyerInfo.visitorId` | `results.${number}.item.buyerInfo.memberId` | `results.${number}.item.paymentStatus` | `results.${number}.item.fulfillmentStatus` | `results.${number}.item.weightUnit` | `results.${number}.item.taxIncludedInPrices` | `results.${number}.item.shippingInfo.title` | `results.${number}.item.status` | `results.${number}.item.attributionSource` | `results.${number}.item.createdBy.userId` | `results.${number}.item.createdBy.memberId` | `results.${number}.item.createdBy.visitorId` | `results.${number}.item.createdBy.appId` | `results.${number}.item.channelInfo.type` | `results.${number}.item.businessLocation._id` | `results.${number}.item.businessLocation.name` | `results.${number}.item.imported` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
9002
+ declare function bulkUpdateOrders(orders: NonNullablePaths<MaskedOrder, `order` | `order._id`, 1>[], options?: BulkUpdateOrdersOptions): Promise<NonNullablePaths<BulkUpdateOrdersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.number` | `results.${number}.item.buyerInfo.visitorId` | `results.${number}.item.buyerInfo.memberId` | `results.${number}.item.paymentStatus` | `results.${number}.item.fulfillmentStatus` | `results.${number}.item.weightUnit` | `results.${number}.item.taxIncludedInPrices` | `results.${number}.item.shippingInfo.title` | `results.${number}.item.status` | `results.${number}.item.attributionSource` | `results.${number}.item.createdBy.userId` | `results.${number}.item.createdBy.memberId` | `results.${number}.item.createdBy.visitorId` | `results.${number}.item.createdBy.appId` | `results.${number}.item.channelInfo.type` | `results.${number}.item.businessLocation._id` | `results.${number}.item.businessLocation.name` | `results.${number}.item.imported` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
9003
9003
  interface BulkUpdateOrdersOptions {
9004
9004
  /**
9005
9005
  * Whether to return the full order entities.
@@ -9184,7 +9184,7 @@ interface UpdateOrderLineItem {
9184
9184
  * @applicableIdentity APP
9185
9185
  * @fqn com.wix.ecom.orders.v1.Orders.AddActivities
9186
9186
  */
9187
- declare function addActivities(orderId: string, options?: NonNullablePaths<AddActivitiesOptions, `orderActivities.${number}.activityType`, 4>): Promise<NonNullablePaths<AddActivitiesResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported` | `activityIds`, 7>>;
9187
+ declare function addActivities(orderId: string, options?: NonNullablePaths<AddActivitiesOptions, `orderActivities.${number}.activityType`, 2>): Promise<NonNullablePaths<AddActivitiesResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported` | `activityIds`, 5>>;
9188
9188
  interface AddActivitiesOptions {
9189
9189
  /**
9190
9190
  * Activities to add to the order.
@@ -9230,7 +9230,7 @@ interface DeleteActivityIdentifiers {
9230
9230
  * @applicableIdentity APP
9231
9231
  * @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
9232
9232
  */
9233
- declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported`, 7> & {
9233
+ declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<NonNullablePaths<CancelOrderResponse, `order.number` | `order.lineItems` | `order.lineItems.${number}._id` | `order.lineItems.${number}.productName.original` | `order.lineItems.${number}.catalogReference.catalogItemId` | `order.lineItems.${number}.catalogReference.appId` | `order.lineItems.${number}.quantity` | `order.lineItems.${number}.totalDiscount.amount` | `order.lineItems.${number}.totalDiscount.formattedAmount` | `order.lineItems.${number}.physicalProperties.shippable` | `order.lineItems.${number}.itemType.preset` | `order.lineItems.${number}.itemType.custom` | `order.lineItems.${number}.paymentOption` | `order.lineItems.${number}.taxDetails.taxRate` | `order.lineItems.${number}.taxInfo.taxIncludedInPrice` | `order.lineItems.${number}.digitalFile.fileId` | `order.lineItems.${number}.subscriptionInfo.cycleNumber` | `order.lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `order.lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `order.lineItems.${number}.priceDescription.original` | `order.lineItems.${number}.taxableAddress.addressType` | `order.lineItems.${number}.priceUndetermined` | `order.lineItems.${number}.fixedQuantity` | `order.lineItems.${number}.decimalQuantity.measurementUnit` | `order.lineItems.${number}.decimalQuantity.otherUnit` | `order.lineItems.${number}.decimalQuantity.value` | `order.lineItems.${number}.decimalQuantity.description.original` | `order.buyerInfo.visitorId` | `order.buyerInfo.memberId` | `order.paymentStatus` | `order.fulfillmentStatus` | `order.weightUnit` | `order.taxIncludedInPrices` | `order.billingInfo.address.streetAddress.number` | `order.billingInfo.address.streetAddress.name` | `order.billingInfo.contactDetails.vatId._id` | `order.billingInfo.contactDetails.vatId.type` | `order.shippingInfo.title` | `order.shippingInfo.logistics.pickupDetails.pickupMethod` | `order.status` | `order.taxInfo.taxBreakdown` | `order.taxInfo.taxBreakdown.${number}.taxName` | `order.taxInfo.taxBreakdown.${number}.taxType` | `order.taxInfo.taxBreakdown.${number}.jurisdiction` | `order.taxInfo.taxBreakdown.${number}.jurisdictionType` | `order.taxInfo.taxBreakdown.${number}.rate` | `order.appliedDiscounts` | `order.appliedDiscounts.${number}.coupon._id` | `order.appliedDiscounts.${number}.coupon.code` | `order.appliedDiscounts.${number}.coupon.name` | `order.appliedDiscounts.${number}.merchantDiscount.discountReason` | `order.appliedDiscounts.${number}.discountRule._id` | `order.appliedDiscounts.${number}.discountRule.name.original` | `order.appliedDiscounts.${number}.discountType` | `order.activities` | `order.activities.${number}.merchantComment.message` | `order.activities.${number}.orderRefunded.manual` | `order.activities.${number}.orderRefunded.reason` | `order.activities.${number}.draftOrderChangesApplied.draftOrderId` | `order.activities.${number}.savedPaymentMethod.name` | `order.activities.${number}.authorizedPaymentCreated.paymentId` | `order.activities.${number}.authorizedPaymentCaptured.paymentId` | `order.activities.${number}.authorizedPaymentVoided.paymentId` | `order.activities.${number}.refundInitiated.refundId` | `order.activities.${number}.paymentRefunded.refundId` | `order.activities.${number}.paymentRefundFailed.refundId` | `order.activities.${number}.paymentPending.paymentId` | `order.activities.${number}.paymentCanceled.paymentId` | `order.activities.${number}.paymentDeclined.paymentId` | `order.activities.${number}.receiptCreated.wixReceipt.receiptId` | `order.activities.${number}.receiptCreated.paymentId` | `order.activities.${number}.receiptSent.paymentId` | `order.activities.${number}.chargebackCreated.paymentId` | `order.activities.${number}.chargebackCreated.chargebackId` | `order.activities.${number}.chargebackReversed.paymentId` | `order.activities.${number}.chargebackReversed.chargebackId` | `order.activities.${number}.type` | `order.activities.${number}.activityType` | `order.attributionSource` | `order.createdBy.userId` | `order.createdBy.memberId` | `order.createdBy.visitorId` | `order.createdBy.appId` | `order.channelInfo.type` | `order.customFields` | `order.customFields.${number}.title` | `order.balanceSummary.balance.amount` | `order.balanceSummary.balance.formattedAmount` | `order.balanceSummary.cashRoundingAdjustment.amount` | `order.balanceSummary.cashRoundingAdjustment.formattedAmount` | `order.additionalFees` | `order.additionalFees.${number}.name` | `order.additionalFees.${number}._id` | `order.additionalFees.${number}.source` | `order.tags.privateTags.tagIds` | `order.businessLocation._id` | `order.businessLocation.name` | `order.platformFeeSummary.fees` | `order.platformFeeSummary.fees.${number}.lineItemId` | `order.platformFeeSummary.fees.${number}.chargeType` | `order.platformFeeSummary.fees.${number}.percentageRate` | `order.imported`, 5> & {
9234
9234
  __applicationErrorsType?: CancelOrderApplicationErrors;
9235
9235
  }>;
9236
9236
  interface CancelOrderOptions {
@@ -9273,7 +9273,7 @@ interface AggregateOrdersOptions {
9273
9273
  * @applicableIdentity APP
9274
9274
  * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
9275
9275
  */
9276
- declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
9276
+ declare function bulkUpdateOrderTags(orderIds: string[], options?: BulkUpdateOrderTagsOptions): Promise<NonNullablePaths<BulkUpdateOrderTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
9277
9277
  interface BulkUpdateOrderTagsOptions {
9278
9278
  /** Tags to be added to orders */
9279
9279
  assignTags?: TagsTags;
@@ -9281,4 +9281,4 @@ interface BulkUpdateOrderTagsOptions {
9281
9281
  unassignTags?: TagsTags;
9282
9282
  }
9283
9283
 
9284
- export { PaymentStatusEnumPaymentStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type Color as a$, FulfillmentStatus as a0, WeightUnit as a1, VatType as a2, PickupMethod as a3, OrderStatus as a4, DiscountType as a5, DiscountReason as a6, LineItemQuantityChangeType as a7, ActivityType as a8, OrderActivityTypeEnumActivityType as a9, AuthorizationVoidStatus as aA, Reason as aB, ActionType as aC, ChargebackStatus as aD, MembershipPaymentStatus as aE, PaymentStatus as aF, CanceledReason as aG, DeclinedReason as aH, VoidedReason as aI, RefundStatus as aJ, SortOrder as aK, OrderApprovalStrategy as aL, Placement as aM, SubdivisionType as aN, SourceType as aO, CustomFieldGroup as aP, ValueType as aQ, DepositType as aR, InvoiceStatus as aS, type OrderLineItem as aT, type ProductName as aU, type CatalogReference as aV, type DescriptionLine as aW, type DescriptionLineValueOneOf as aX, type DescriptionLineDescriptionLineValueOneOf as aY, type DescriptionLineName as aZ, type PlainTextValue as a_, AttributionSource as aa, ChannelType as ab, AdditionalFeeSource as ac, OrderActionType as ad, SpecificItemsCouponBehavior as ae, ChargeType as af, VersioningMode as ag, DeltaPaymentOptionType as ah, InventoryAction as ai, WebhookIdentityType as aj, PreviewEmailType as ak, State as al, SiteCreatedContext as am, Namespace as an, DeleteStatus as ao, Origin as ap, ScheduledAction as aq, DurationUnit as ar, PaymentCollectabilityStatus as as, PredefinedPaymentMethod as at, RefundableStatus as au, NonRefundableReason as av, ManuallyRefundableReason as aw, RestockType as ax, TransactionStatus as ay, AuthorizationCaptureStatus as az, type SetOrderNumberCounterResponse as b, type MerchantComment as b$, type FocalPoint as b0, type PhysicalProperties as b1, type Dimensions as b2, type ItemType as b3, type ItemTypeItemTypeDataOneOf as b4, type RestockLocation as b5, type ItemTaxFullDetails as b6, type LineItemTaxInfo as b7, type LineItemTaxBreakdown as b8, type DigitalFile as b9, type AddressLocation as bA, type FullAddressContactDetails as bB, type VatId as bC, type V1ShippingInformation as bD, type DeliveryLogistics as bE, type DeliveryLogisticsAddressOneOf as bF, type PickupDetails as bG, type PickupAddress as bH, type DeliveryTimeSlot as bI, type ShippingPrice as bJ, type ShippingRegion as bK, type TaxSummary as bL, type OrderTaxInfo as bM, type OrderTaxBreakdown as bN, type AppliedDiscount as bO, type AppliedDiscountDiscountSourceOneOf as bP, type Coupon as bQ, type MerchantDiscount as bR, type MerchantDiscountMerchantDiscountReasonOneOf as bS, type DiscountRule as bT, type DiscountRuleName as bU, type LineItemDiscount as bV, type ItemCombination as bW, type ItemCombinationLineItem as bX, type Activity as bY, type ActivityContentOneOf as bZ, type CustomActivity as b_, type SubscriptionInfo as ba, type SubscriptionTitle as bb, type SubscriptionDescription as bc, type SubscriptionSettings as bd, type FreeTrialPeriod as be, type BillingSettings as bf, type BillingAdjustment as bg, type BillingAdjustmentPriceSummary as bh, type PriceDescription as bi, type LocationAndQuantity as bj, type TaxableAddress as bk, type TaxableAddressTaxableAddressDataOneOf as bl, type DecimalQuantity as bm, type DecimalQuantityUnitOneOf as bn, type TranslatableString as bo, type ExtendedFields as bp, type ModifierGroup as bq, type ItemModifier as br, type ServiceProperties as bs, type BuyerInfo as bt, type BuyerInfoIdOneOf as bu, type CurrencyConversionDetails as bv, type PriceSummary as bw, type AddressWithContact as bx, type Address as by, type StreetAddress as bz, type SetOrderNumberCounterApplicationErrors as c, type OrderSettings as c$, type OrderRefunded as c0, type OrderCreatedFromExchange as c1, type NewExchangeOrderCreated as c2, type LineItemExchangeData as c3, type DraftOrderChangesApplied as c4, type OrderChange as c5, type OrderChangeValueOneOf as c6, type LineItemChanges as c7, type LineItemQuantityChange as c8, type LineItemPriceChange as c9, type RegularPayment as cA, type RegularPaymentPaymentMethodDetailsOneOf as cB, type CreditCardDetails as cC, type PaymentCanceled as cD, type PaymentCanceledPaymentDetailsOneOf as cE, type PaymentDeclined as cF, type PaymentDeclinedPaymentDetailsOneOf as cG, type ReceiptCreated as cH, type ReceiptCreatedReceiptInfoOneOf as cI, type WixReceipt as cJ, type ExternalReceipt as cK, type ReceiptSent as cL, type ReceiptSentReceiptInfoOneOf as cM, type ChargebackCreated as cN, type ChargebackReversed as cO, type CreatedBy as cP, type CreatedByStringOneOf as cQ, type ChannelInfo as cR, type CustomField as cS, type BalanceSummary as cT, type Balance as cU, type CashRounding as cV, type AdditionalFee as cW, type FulfillmentStatusesAggregate as cX, type Tags as cY, type TagList as cZ, type Location as c_, type LineItemProductNameChange as ca, type LineItemDescriptionLineChange as cb, type LineItemModifiersChange as cc, type ManagedLineItem as cd, type ManagedDiscount as ce, type TranslatedValue as cf, type LineItemAmount as cg, type ManagedAdditionalFee as ch, type TotalPriceChange as ci, type ShippingInformationChange as cj, type ShippingInformation as ck, type SavedPaymentMethod as cl, type AuthorizedPaymentCreated as cm, type AuthorizedPaymentCaptured as cn, type AuthorizedPaymentVoided as co, type RefundInitiated as cp, type RefundedPayment as cq, type RefundedPaymentKindOneOf as cr, type RegularPaymentRefund as cs, type GiftCardPaymentRefund as ct, type MembershipPaymentRefund as cu, type PaymentRefunded as cv, type PaymentRefundFailed as cw, type RefundedAsStoreCredit as cx, type PaymentPending as cy, type PaymentPendingPaymentDetailsOneOf as cz, type PreparePaymentCollectionOptions as d, type SendBuyerConfirmationEmailResponse as d$, type OrderSettingsAllowedActionsOneOf as d0, type OrderSettingsEditableByOneOf as d1, type CustomAllowedActions as d2, type OwnerApps as d3, type FormInfo as d4, type FormIdentifier as d5, type PlatformFeeSummary as d6, type PlatformFee as d7, type UpdateInternalDocumentsEvent as d8, type UpdateInternalDocumentsEventOperationOneOf as d9, type LineItemDelta as dA, type LineItemDeltaDeltaOneOf as dB, type AppliedDiscountDelta as dC, type AppliedDiscountDeltaDeltaOneOf as dD, type AdditionalFeeDelta as dE, type AdditionalFeeDeltaDeltaOneOf as dF, type DraftOrderCommitSettings as dG, type InventoryUpdateDetails as dH, type TriggerReindexRequest as dI, type TriggerReindexResponse as dJ, type DomainEvent as dK, type DomainEventBodyOneOf as dL, type EntityCreatedEvent as dM, type RestoreInfo as dN, type EntityUpdatedEvent as dO, type EntityDeletedEvent as dP, type ActionEvent as dQ, type Empty as dR, type TriggerReindexOrderRequest as dS, type MessageEnvelope as dT, type IdentificationData as dU, type IdentificationDataIdOneOf as dV, type AccountInfo as dW, type ImportOrderRequest as dX, type SetOrderNumberCounterRequest as dY, type BulkDeleteImportedOrdersRequest as dZ, type SendBuyerConfirmationEmailRequest as d_, type InternalDocument as da, type InternalDocumentUpdateOperation as db, type DeleteByIdsOperation as dc, type DeleteByFilterOperation as dd, type InternalDocumentUpdateByFilterOperation as de, type InternalUpdateExistingOperation as df, type VersionedDocumentUpdateOperation as dg, type VersionedDeleteByIdsOperation as dh, type VersionedDocumentId as di, type OrderApproved as dj, type OrdersExperiments as dk, type OrderRejectedEventOrderRejected as dl, type OrderItemsRestocked as dm, type V1RestockItem as dn, type OrderImported as dp, type ImportedOrderDeleted as dq, type PaymentStatusUpdated as dr, type FulfillmentStatusUpdated as ds, type OrderCanceledEventOrderCanceled as dt, type OrderDeltasCommitted as du, type CommittedDiffs as dv, type CommittedDiffsShippingUpdateInfoOneOf as dw, type ItemChangedDetails as dx, type OrderLineItemChangedDetails as dy, type DecimalQuantityUpdate as dz, type PreparePaymentCollectionResponse as e, type SitePurgedExternally as e$, type SendBuyerPaymentsReceivedEmailRequest as e0, type SendBuyerPaymentsReceivedEmailResponse as e1, type SendBuyerPickupConfirmationEmailRequest as e2, type SendBuyerPickupConfirmationEmailResponse as e3, type BulkSendBuyerPickupConfirmationEmailsRequest as e4, type BulkSendBuyerPickupConfirmationEmailsResponse as e5, type SendBuyerShippingConfirmationEmailRequest as e6, type SendBuyerShippingConfirmationEmailResponse as e7, type BulkSendBuyerShippingConfirmationEmailsRequest as e8, type BulkSendBuyerShippingConfirmationEmailsResponse as e9, type PreviewBuyerConfirmationEmailResponse as eA, type PreviewBuyerPickupConfirmationEmailRequest as eB, type PreviewBuyerPickupConfirmationEmailResponse as eC, type PreviewShippingConfirmationEmailRequest as eD, type PreviewShippingConfirmationEmailResponse as eE, type PreviewResendDownloadLinksEmailRequest as eF, type PreviewResendDownloadLinksEmailResponse as eG, type MetaSiteSpecialEvent as eH, type MetaSiteSpecialEventPayloadOneOf as eI, type Asset as eJ, type SiteCreated as eK, type SiteTransferred as eL, type SiteDeleted as eM, type DeleteContext as eN, type SiteUndeleted as eO, type SitePublished as eP, type SiteUnpublished as eQ, type SiteMarkedAsTemplate as eR, type SiteMarkedAsWixSite as eS, type ServiceProvisioned as eT, type ServiceRemoved as eU, type SiteRenamed as eV, type SiteHardDeleted as eW, type NamespaceChanged as eX, type StudioAssigned as eY, type StudioUnassigned as eZ, type SiteUrlChanged as e_, type SendMerchantOrderReceivedNotificationRequest as ea, type SendMerchantOrderReceivedNotificationResponse as eb, type SendCancelRefundEmailRequest as ec, type SendCancelRefundEmailResponse as ed, type SendRefundEmailRequest as ee, type SendRefundEmailResponse as ef, type SendFulfillmentEmailRequest as eg, type SendFulfillmentEmailResponse as eh, type SendMerchantOrderReceivedPushRequest as ei, type SendMerchantOrderReceivedPushResponse as ej, type PreviewEmailByTypeRequest as ek, type PreviewEmailByTypeResponse as el, type PreviewRefundEmailRequest as em, type RefundDetails as en, type RefundItem as eo, type LineItemRefund as ep, type AdditionalFeeRefund as eq, type ShippingRefund as er, type PreviewRefundEmailResponse as es, type PreviewCancelEmailRequest as et, type PreviewCancelEmailResponse as eu, type PreviewCancelRefundEmailRequest as ev, type PreviewCancelRefundEmailResponse as ew, type PreviewBuyerPaymentsReceivedEmailRequest as ex, type PreviewBuyerPaymentsReceivedEmailResponse as ey, type PreviewBuyerConfirmationEmailRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type AuthorizationVoid as f$, type OdeditorAssigned as f0, type OdeditorUnassigned as f1, type PicassoAssigned as f2, type PicassoUnassigned as f3, type WixelAssigned as f4, type WixelUnassigned as f5, type StudioTwoAssigned as f6, type StudioTwoUnassigned as f7, type UserDomainMediaEnabled as f8, type UserDomainMediaDisabled as f9, type GetRefundabilityStatusResponse as fA, type Refundability as fB, type RefundabilityAdditionalRefundabilityInfoOneOf as fC, type CreatePaymentGatewayOrderRequest as fD, type ChargedBy as fE, type CreatePaymentGatewayOrderResponse as fF, type ChargeMembershipsRequest as fG, type MembershipChargeItem as fH, type MembershipName as fI, type ChargeMembershipsResponse as fJ, type TriggerRefundRequest as fK, type PaymentRefund as fL, type RefundSideEffects as fM, type RestockInfo as fN, type RestockItem as fO, type TriggerRefundResponse as fP, type OrderTransactions as fQ, type Payment as fR, type PaymentPaymentDetailsOneOf as fS, type PaymentReceiptInfoOneOf as fT, type PaymentStatusDetailsOneOf as fU, type RegularPaymentDetails as fV, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fW, type CreditCardPaymentMethodDetails as fX, type AuthorizationDetails as fY, type AuthorizationCapture as fZ, type AuthorizationActionFailureDetails as f_, type EditorlessAssigned as fa, type EditorlessUnassigned as fb, type HasCustomEmailConfigurationsRequest as fc, type HasCustomEmailConfigurationsResponse as fd, type AddToAutomationMigrationPopulationRequest as fe, type AddToAutomationMigrationPopulationResponse as ff, type IsInAutomationMigrationPopulationRequest as fg, type IsInAutomationMigrationPopulationResponse as fh, type PreparePaymentCollectionRequest as fi, type RedirectUrls as fj, type DelayedCaptureSettings as fk, type Duration as fl, type GetPaymentCollectabilityStatusRequest as fm, type RecordManuallyCollectedPaymentRequest as fn, type UserDefinedPaymentMethodName as fo, type UserDefinedPaymentMethodNameKindOneOf as fp, type RecordManuallyCollectedPaymentResponse as fq, type MarkOrderAsPaidRequest as fr, type MarkOrderAsPaidResponse as fs, type BulkMarkOrdersAsPaidRequest as ft, type BulkMarkOrdersAsPaidResponse as fu, type BulkOrderResult as fv, type ItemMetadata as fw, type ApplicationError as fx, type BulkActionMetadata as fy, type GetRefundabilityStatusRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type DraftOrderDiffsRecipientUpdateInfoOneOf as g$, type V1ScheduledAction as g0, type Chargeback as g1, type PaymentMethodName as g2, type GiftCardPaymentDetails as g3, type MembershipPaymentDetails as g4, type FutureMembershipDetails as g5, type WixReceiptInfo as g6, type ExternalReceiptInfo as g7, type CashRoundingDetails as g8, type CanceledStatusDetails as g9, type PlatformQuery as gA, type PlatformQueryPagingMethodOneOf as gB, type Sorting as gC, type PlatformPaging as gD, type CursorPaging as gE, type InternalQueryOrdersResponse as gF, type PlatformPagingMetadata as gG, type Cursors as gH, type QueryOrderRequest as gI, type QueryOrderResponse as gJ, type SearchOrdersRequest as gK, type CursorSearch as gL, type CursorSearchPagingMethodOneOf as gM, type CursorPagingMetadata as gN, type CreateOrderRequest as gO, type OrderCreationSettings as gP, type OrderCreationSettingsEditableByOneOf as gQ, type OrderCreateNotifications as gR, type CreateOrderResponse as gS, type UpdateOrderRequest as gT, type UpdateOrderResponse as gU, type BulkUpdateOrdersRequest as gV, type CommitDeltasRequest as gW, type DraftOrderDiffs as gX, type DraftOrderDiffsShippingUpdateInfoOneOf as gY, type DraftOrderDiffsBuyerUpdateInfoOneOf as gZ, type DraftOrderDiffsBillingUpdateInfoOneOf as g_, type DeclinedStatusDetails as ga, type VoidedStatusDetails as gb, type PaymentStatusDetails as gc, type PaymentStatusDetailsStatusDetailsOneOf as gd, type Refund as ge, type RefundTransaction as gf, type RefundStatusInfo as gg, type AggregatedRefundSummary as gh, type RefundItemsBreakdown as gi, type LineItemRefundSummary as gj, type CalculateRefundRequest as gk, type CalculateRefundItemRequest as gl, type CalculateRefundResponse as gm, type CalculateRefundItemResponse as gn, type VoidAuthorizedPaymentsRequest as go, type CaptureAuthorizedPaymentsRequest as gp, type ChargeSavedPaymentMethodRequest as gq, type ChargeSavedPaymentMethodResponse as gr, type V1TriggerReindexRequest as gs, type V1TriggerReindexResponse as gt, type V1TriggerReindexOrderRequest as gu, type DiffmatokyPayload as gv, type ErrorInformation as gw, type GetOrderRequest as gx, type GetOrderResponse as gy, type InternalQueryOrdersRequest as gz, type PaymentCapture as h, type UpdateLineItemsDescriptionLinesResponse as h$, type V1LineItemDelta as h0, type V1LineItemDeltaDeltaOneOf as h1, type CommitDeltasResponse as h2, type ArchiveOrderRequest as h3, type ArchiveOrderResponse as h4, type BulkArchiveOrdersRequest as h5, type BulkArchiveOrdersResponse as h6, type BulkArchiveOrdersByFilterRequest as h7, type BulkArchiveOrdersByFilterResponse as h8, type UnArchiveOrderRequest as h9, type OrderCanceled as hA, type DownloadLinkSent as hB, type TrackingNumberAdded as hC, type TrackingNumberEdited as hD, type TrackingLinkAdded as hE, type ShippingConfirmationEmailSent as hF, type InvoiceAdded as hG, type InvoiceSent as hH, type FulfillerEmailSent as hI, type ShippingAddressEdited as hJ, type EmailEdited as hK, type PickupReadyEmailSent as hL, type OrderPartiallyPaid as hM, type OrderPending as hN, type OrderRejected as hO, type AddInternalActivityResponse as hP, type AddActivityRequest as hQ, type PublicActivity as hR, type PublicActivityContentOneOf as hS, type AddActivityResponse as hT, type AddActivitiesRequest as hU, type UpdateActivityRequest as hV, type UpdateActivityResponse as hW, type DeleteActivityRequest as hX, type DeleteActivityResponse as hY, type UpdateLineItemsDescriptionLinesRequest as hZ, type LineItemUpdate as h_, type UnArchiveOrderResponse as ha, type BulkUnArchiveOrdersRequest as hb, type BulkUnArchiveOrdersResponse as hc, type BulkUnArchiveOrdersByFilterRequest as hd, type BulkUnArchiveOrdersByFilterResponse as he, type UpdateBuyerInfoRequest as hf, type BuyerInfoUpdate as hg, type UpdateBuyerInfoResponse as hh, type UpdateBuyerEmailRequest as hi, type UpdateBuyerEmailResponse as hj, type UpdateOrderShippingAddressRequest as hk, type UpdateOrderShippingAddressResponse as hl, type UpdateBillingContactDetailsRequest as hm, type UpdateBillingContactDetailsResponse as hn, type UpdateOrderLineItemRequest as ho, type UpdateOrderLineItemResponse as hp, type UpdateOrderLineItemsRequest as hq, type MaskedOrderLineItem as hr, type UpdateOrderLineItemsResponse as hs, type AddInternalActivityRequest as ht, type InternalActivity as hu, type InternalActivityContentOneOf as hv, type OrderPlaced as hw, type OrderPaid as hx, type OrderFulfilled as hy, type OrderNotFulfilled as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type LineItems as i$, type MarkOrderAsSeenByHumanRequest as i0, type MarkOrderAsSeenByHumanResponse as i1, type CancelOrderRequest as i2, type UpdateOrderStatusRequest as i3, type UpdateOrderStatusResponse as i4, type MarkAsFulfilledRequest as i5, type MarkAsFulfilledResponse as i6, type BulkMarkAsFulfilledRequest as i7, type BulkMarkAsFulfilledResponse as i8, type BulkMarkAsFulfilledByFilterRequest as i9, type TagsTags as iA, type TagsTagList as iB, type BulkUpdateOrderTagsResult as iC, type SendOrderUpdatedDomainEventRequest as iD, type SendOrderUpdatedDomainEventResponse as iE, type Task as iF, type TaskKey as iG, type TaskAction as iH, type TaskActionActionOneOf as iI, type Complete as iJ, type Cancel as iK, type Reschedule as iL, type InvoiceSentEvent as iM, type IdAndVersion as iN, type InvoiceFields as iO, type Customer as iP, type Email as iQ, type QuotesAddress as iR, type AddressDescription as iS, type Phone as iT, type Company as iU, type CommonAddress as iV, type CommonAddressStreetOneOf as iW, type Subdivision as iX, type StandardDetails as iY, type ShippingContactDetails as iZ, type InvoiceDates as i_, type BulkMarkAsFulfilledByFilterResponse as ia, type MarkAsUnfulfilledRequest as ib, type MarkAsUnfulfilledResponse as ic, type BulkMarkAsUnfulfilledRequest as id, type BulkMarkAsUnfulfilledResponse as ie, type BulkMarkAsUnfulfilledByFilterRequest as ig, type BulkMarkAsUnfulfilledByFilterResponse as ih, type BulkSetBusinessLocationRequest as ii, type BulkSetBusinessLocationResponse as ij, type BulkSetBusinessLocationResult as ik, type V1MarkOrderAsPaidRequest as il, type V1MarkOrderAsPaidResponse as im, type V1BulkMarkOrdersAsPaidRequest as io, type V1BulkMarkOrdersAsPaidResponse as ip, type V1CreatePaymentGatewayOrderRequest as iq, type V1CreatePaymentGatewayOrderResponse as ir, type GetShipmentsRequest as is, type GetShipmentsResponse as it, type AggregateOrdersRequest as iu, type AggregateOrdersResponse as iv, type DecrementItemsQuantityRequest as iw, type DecrementData as ix, type DecrementItemsQuantityResponse as iy, type BulkUpdateOrderTagsRequest as iz, type GetOrderApplicationErrors as j, type InventoryActionWithLiterals as j$, type LineItem as j0, type BigDecimalWrapper as j1, type LineItemTax as j2, type Source as j3, type LineItemMetaData as j4, type Locale as j5, type TotalPrice as j6, type ItemizedFee as j7, type Discount as j8, type DiscountOneDiscountTypeOneOf as j9, type ItemTypePresetWithLiterals as jA, type PaymentOptionTypeWithLiterals as jB, type JurisdictionTypeWithLiterals as jC, type SubscriptionFrequencyWithLiterals as jD, type ProductPeriodAlignmentWithLiterals as jE, type AdjustmentTypeWithLiterals as jF, type TaxableAddressTypeWithLiterals as jG, type MeasurementUnitWithLiterals as jH, type PaymentStatusEnumPaymentStatusWithLiterals as jI, type FulfillmentStatusWithLiterals as jJ, type WeightUnitWithLiterals as jK, type VatTypeWithLiterals as jL, type PickupMethodWithLiterals as jM, type OrderStatusWithLiterals as jN, type DiscountTypeWithLiterals as jO, type DiscountReasonWithLiterals as jP, type LineItemQuantityChangeTypeWithLiterals as jQ, type ActivityTypeWithLiterals as jR, type OrderActivityTypeEnumActivityTypeWithLiterals as jS, type AttributionSourceWithLiterals as jT, type ChannelTypeWithLiterals as jU, type AdditionalFeeSourceWithLiterals as jV, type OrderActionTypeWithLiterals as jW, type SpecificItemsCouponBehaviorWithLiterals as jX, type ChargeTypeWithLiterals as jY, type VersioningModeWithLiterals as jZ, type DeltaPaymentOptionTypeWithLiterals as j_, 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 RecordManuallyCollectedPaymentOptions as jm, type PaymentCollectionMarkOrderAsPaidOptions as jn, type PaymentCollectionCreatePaymentGatewayOrderOptions as jo, type ChargeMembershipsOptions as jp, type TriggerRefundOptions as jq, type OrderSearchSpec as jr, type UpdateOrderLineItemIdentifiers as js, type UpdateOrderLineItem as jt, type UpdateActivityIdentifiers as ju, type DeleteActivityIdentifiers as jv, type AggregateOrdersOptions as jw, utils as jx, type DescriptionLineTypeWithLiterals as jy, type DimensionsUnitWithLiterals as jz, type OrderSearch as k, cancelOrder as k$, type WebhookIdentityTypeWithLiterals as k0, type PreviewEmailTypeWithLiterals as k1, type StateWithLiterals as k2, type SiteCreatedContextWithLiterals as k3, type NamespaceWithLiterals as k4, type DeleteStatusWithLiterals as k5, type OriginWithLiterals as k6, type ScheduledActionWithLiterals as k7, type DurationUnitWithLiterals as k8, type PaymentCollectabilityStatusWithLiterals as k9, type RecordManuallyCollectedPaymentApplicationErrors as kA, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kB, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kC, type TriggerRefundApplicationErrors as kD, type UpdateOrderStatusApplicationErrors as kE, type CommonSearchWithEntityContext as kF, onOrderApproved as kG, onOrderCanceled as kH, onOrderCommitted as kI, onOrderCreated as kJ, onOrderFulfilled as kK, onOrderImported as kL, onOrderImportedOrderDeleted as kM, onOrderPaymentStatusUpdated as kN, onOrderUpdated as kO, importOrder as kP, setOrderNumberCounter as kQ, bulkDeleteImportedOrders as kR, preparePaymentCollection as kS, getPaymentCollectabilityStatus as kT, voidAuthorizedPayments as kU, captureAuthorizedPayments as kV, getOrder as kW, createOrder as kX, updateOrder as kY, bulkUpdateOrders as kZ, addActivities as k_, type PredefinedPaymentMethodWithLiterals as ka, type RefundableStatusWithLiterals as kb, type NonRefundableReasonWithLiterals as kc, type ManuallyRefundableReasonWithLiterals as kd, type RestockTypeWithLiterals as ke, type TransactionStatusWithLiterals as kf, type AuthorizationCaptureStatusWithLiterals as kg, type AuthorizationVoidStatusWithLiterals as kh, type ReasonWithLiterals as ki, type ActionTypeWithLiterals as kj, type ChargebackStatusWithLiterals as kk, type MembershipPaymentStatusWithLiterals as kl, type PaymentStatusWithLiterals as km, type CanceledReasonWithLiterals as kn, type DeclinedReasonWithLiterals as ko, type VoidedReasonWithLiterals as kp, type RefundStatusWithLiterals as kq, type SortOrderWithLiterals as kr, type OrderApprovalStrategyWithLiterals as ks, type PlacementWithLiterals as kt, type SubdivisionTypeWithLiterals as ku, type SourceTypeWithLiterals as kv, type CustomFieldGroupWithLiterals as kw, type ValueTypeWithLiterals as kx, type DepositTypeWithLiterals as ky, type InvoiceStatusWithLiterals as kz, type SearchOrdersResponse as l, bulkUpdateOrderTags as l0, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };
9284
+ export { PaymentStatusEnumPaymentStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type Color as a$, FulfillmentStatus as a0, WeightUnit as a1, VatType as a2, PickupMethod as a3, OrderStatus as a4, DiscountType as a5, DiscountReason as a6, LineItemQuantityChangeType as a7, ActivityType as a8, OrderActivityTypeEnumActivityType as a9, CanceledReason as aA, DeclinedReason as aB, VoidedReason as aC, RefundStatus as aD, PreviewEmailType as aE, State as aF, SiteCreatedContext as aG, Namespace as aH, DeleteStatus as aI, Origin as aJ, SortOrder as aK, OrderApprovalStrategy as aL, Placement as aM, SubdivisionType as aN, SourceType as aO, CustomFieldGroup as aP, ValueType as aQ, DepositType as aR, InvoiceStatus as aS, type OrderLineItem as aT, type ProductName as aU, type CatalogReference as aV, type DescriptionLine as aW, type DescriptionLineValueOneOf as aX, type DescriptionLineDescriptionLineValueOneOf as aY, type DescriptionLineName as aZ, type PlainTextValue as a_, AttributionSource as aa, ChannelType as ab, AdditionalFeeSource as ac, OrderActionType as ad, SpecificItemsCouponBehavior as ae, ChargeType as af, VersioningMode as ag, DeltaPaymentOptionType as ah, InventoryAction as ai, WebhookIdentityType as aj, ScheduledAction as ak, DurationUnit as al, PaymentCollectabilityStatus as am, PredefinedPaymentMethod as an, RefundableStatus as ao, NonRefundableReason as ap, ManuallyRefundableReason as aq, RestockType as ar, TransactionStatus as as, AuthorizationCaptureStatus as at, AuthorizationVoidStatus as au, Reason as av, ActionType as aw, ChargebackStatus as ax, MembershipPaymentStatus as ay, PaymentStatus as az, type SetOrderNumberCounterResponse as b, type MerchantComment as b$, type FocalPoint as b0, type PhysicalProperties as b1, type Dimensions as b2, type ItemType as b3, type ItemTypeItemTypeDataOneOf as b4, type RestockLocation as b5, type ItemTaxFullDetails as b6, type LineItemTaxInfo as b7, type LineItemTaxBreakdown as b8, type DigitalFile as b9, type AddressLocation as bA, type FullAddressContactDetails as bB, type VatId as bC, type V1ShippingInformation as bD, type DeliveryLogistics as bE, type DeliveryLogisticsAddressOneOf as bF, type PickupDetails as bG, type PickupAddress as bH, type DeliveryTimeSlot as bI, type ShippingPrice as bJ, type ShippingRegion as bK, type TaxSummary as bL, type OrderTaxInfo as bM, type OrderTaxBreakdown as bN, type AppliedDiscount as bO, type AppliedDiscountDiscountSourceOneOf as bP, type Coupon as bQ, type MerchantDiscount as bR, type MerchantDiscountMerchantDiscountReasonOneOf as bS, type DiscountRule as bT, type DiscountRuleName as bU, type LineItemDiscount as bV, type ItemCombination as bW, type ItemCombinationLineItem as bX, type Activity as bY, type ActivityContentOneOf as bZ, type CustomActivity as b_, type SubscriptionInfo as ba, type SubscriptionTitle as bb, type SubscriptionDescription as bc, type SubscriptionSettings as bd, type FreeTrialPeriod as be, type BillingSettings as bf, type BillingAdjustment as bg, type BillingAdjustmentPriceSummary as bh, type PriceDescription as bi, type LocationAndQuantity as bj, type TaxableAddress as bk, type TaxableAddressTaxableAddressDataOneOf as bl, type DecimalQuantity as bm, type DecimalQuantityUnitOneOf as bn, type TranslatableString as bo, type ExtendedFields as bp, type ModifierGroup as bq, type ItemModifier as br, type ServiceProperties as bs, type BuyerInfo as bt, type BuyerInfoIdOneOf as bu, type CurrencyConversionDetails as bv, type PriceSummary as bw, type AddressWithContact as bx, type Address as by, type StreetAddress as bz, type SetOrderNumberCounterApplicationErrors as c, type OrderSettings as c$, type OrderRefunded as c0, type OrderCreatedFromExchange as c1, type NewExchangeOrderCreated as c2, type LineItemExchangeData as c3, type DraftOrderChangesApplied as c4, type OrderChange as c5, type OrderChangeValueOneOf as c6, type LineItemChanges as c7, type LineItemQuantityChange as c8, type LineItemPriceChange as c9, type RegularPayment as cA, type RegularPaymentPaymentMethodDetailsOneOf as cB, type CreditCardDetails as cC, type PaymentCanceled as cD, type PaymentCanceledPaymentDetailsOneOf as cE, type PaymentDeclined as cF, type PaymentDeclinedPaymentDetailsOneOf as cG, type ReceiptCreated as cH, type ReceiptCreatedReceiptInfoOneOf as cI, type WixReceipt as cJ, type ExternalReceipt as cK, type ReceiptSent as cL, type ReceiptSentReceiptInfoOneOf as cM, type ChargebackCreated as cN, type ChargebackReversed as cO, type CreatedBy as cP, type CreatedByStringOneOf as cQ, type ChannelInfo as cR, type CustomField as cS, type BalanceSummary as cT, type Balance as cU, type CashRounding as cV, type AdditionalFee as cW, type FulfillmentStatusesAggregate as cX, type Tags as cY, type TagList as cZ, type Location as c_, type LineItemProductNameChange as ca, type LineItemDescriptionLineChange as cb, type LineItemModifiersChange as cc, type ManagedLineItem as cd, type ManagedDiscount as ce, type TranslatedValue as cf, type LineItemAmount as cg, type ManagedAdditionalFee as ch, type TotalPriceChange as ci, type ShippingInformationChange as cj, type ShippingInformation as ck, type SavedPaymentMethod as cl, type AuthorizedPaymentCreated as cm, type AuthorizedPaymentCaptured as cn, type AuthorizedPaymentVoided as co, type RefundInitiated as cp, type RefundedPayment as cq, type RefundedPaymentKindOneOf as cr, type RegularPaymentRefund as cs, type GiftCardPaymentRefund as ct, type MembershipPaymentRefund as cu, type PaymentRefunded as cv, type PaymentRefundFailed as cw, type RefundedAsStoreCredit as cx, type PaymentPending as cy, type PaymentPendingPaymentDetailsOneOf as cz, type PreparePaymentCollectionOptions as d, type V1TriggerReindexResponse as d$, type OrderSettingsAllowedActionsOneOf as d0, type OrderSettingsEditableByOneOf as d1, type CustomAllowedActions as d2, type OwnerApps as d3, type FormInfo as d4, type FormIdentifier as d5, type PlatformFeeSummary as d6, type PlatformFee as d7, type UpdateInternalDocumentsEvent as d8, type UpdateInternalDocumentsEventOperationOneOf as d9, type LineItemDelta as dA, type LineItemDeltaDeltaOneOf as dB, type AppliedDiscountDelta as dC, type AppliedDiscountDeltaDeltaOneOf as dD, type AdditionalFeeDelta as dE, type AdditionalFeeDeltaDeltaOneOf as dF, type DraftOrderCommitSettings as dG, type InventoryUpdateDetails as dH, type TriggerReindexRequest as dI, type TriggerReindexResponse as dJ, type DomainEvent as dK, type DomainEventBodyOneOf as dL, type EntityCreatedEvent as dM, type RestoreInfo as dN, type EntityUpdatedEvent as dO, type EntityDeletedEvent as dP, type ActionEvent as dQ, type Empty as dR, type TriggerReindexOrderRequest as dS, type MessageEnvelope as dT, type IdentificationData as dU, type IdentificationDataIdOneOf as dV, type AccountInfo as dW, type ImportOrderRequest as dX, type SetOrderNumberCounterRequest as dY, type BulkDeleteImportedOrdersRequest as dZ, type V1TriggerReindexRequest as d_, type InternalDocument as da, type InternalDocumentUpdateOperation as db, type DeleteByIdsOperation as dc, type DeleteByFilterOperation as dd, type InternalDocumentUpdateByFilterOperation as de, type InternalUpdateExistingOperation as df, type VersionedDocumentUpdateOperation as dg, type VersionedDeleteByIdsOperation as dh, type VersionedDocumentId as di, type OrderApproved as dj, type OrdersExperiments as dk, type OrderRejectedEventOrderRejected as dl, type OrderItemsRestocked as dm, type V1RestockItem as dn, type OrderImported as dp, type ImportedOrderDeleted as dq, type PaymentStatusUpdated as dr, type FulfillmentStatusUpdated as ds, type OrderCanceledEventOrderCanceled as dt, type OrderDeltasCommitted as du, type CommittedDiffs as dv, type CommittedDiffsShippingUpdateInfoOneOf as dw, type ItemChangedDetails as dx, type OrderLineItemChangedDetails as dy, type DecimalQuantityUpdate as dz, type PreparePaymentCollectionResponse as e, type VoidedStatusDetails as e$, type V1TriggerReindexOrderRequest as e0, type PreparePaymentCollectionRequest as e1, type RedirectUrls as e2, type DelayedCaptureSettings as e3, type Duration as e4, type GetPaymentCollectabilityStatusRequest as e5, type RecordManuallyCollectedPaymentRequest as e6, type UserDefinedPaymentMethodName as e7, type UserDefinedPaymentMethodNameKindOneOf as e8, type RecordManuallyCollectedPaymentResponse as e9, type RefundSideEffects as eA, type RestockInfo as eB, type RestockItem as eC, type TriggerRefundResponse as eD, type OrderTransactions as eE, type Payment as eF, type PaymentPaymentDetailsOneOf as eG, type PaymentReceiptInfoOneOf as eH, type PaymentStatusDetailsOneOf as eI, type RegularPaymentDetails as eJ, type RegularPaymentDetailsPaymentMethodDetailsOneOf as eK, type CreditCardPaymentMethodDetails as eL, type AuthorizationDetails as eM, type AuthorizationCapture as eN, type AuthorizationActionFailureDetails as eO, type AuthorizationVoid as eP, type V1ScheduledAction as eQ, type Chargeback as eR, type PaymentMethodName as eS, type GiftCardPaymentDetails as eT, type MembershipPaymentDetails as eU, type FutureMembershipDetails as eV, type WixReceiptInfo as eW, type ExternalReceiptInfo as eX, type CashRoundingDetails as eY, type CanceledStatusDetails as eZ, type DeclinedStatusDetails as e_, type MarkOrderAsPaidRequest as ea, type MarkOrderAsPaidResponse as eb, type BulkMarkOrdersAsPaidRequest as ec, type BulkMarkOrdersAsPaidResponse as ed, type BulkOrderResult as ee, type ItemMetadata as ef, type ApplicationError as eg, type BulkActionMetadata as eh, type GetRefundabilityStatusRequest as ei, type GetRefundabilityStatusResponse as ej, type Refundability as ek, type RefundabilityAdditionalRefundabilityInfoOneOf as el, type CreatePaymentGatewayOrderRequest as em, type ChargedBy as en, type CreatePaymentGatewayOrderResponse as eo, type ChargeMembershipsRequest as ep, type MembershipChargeItem as eq, type MembershipName as er, type ChargeMembershipsResponse as es, type TriggerRefundRequest as et, type PaymentRefund as eu, type RefundDetails as ev, type RefundItem as ew, type LineItemRefund as ex, type AdditionalFeeRefund as ey, type ShippingRefund as ez, type PreparePaymentCollectionApplicationErrors as f, type SiteUndeleted as f$, type PaymentStatusDetails as f0, type PaymentStatusDetailsStatusDetailsOneOf as f1, type Refund as f2, type RefundTransaction as f3, type RefundStatusInfo as f4, type AggregatedRefundSummary as f5, type RefundItemsBreakdown as f6, type LineItemRefundSummary as f7, type CalculateRefundRequest as f8, type CalculateRefundItemRequest as f9, type SendMerchantOrderReceivedPushRequest as fA, type SendMerchantOrderReceivedPushResponse as fB, type PreviewEmailByTypeRequest as fC, type PreviewEmailByTypeResponse as fD, type PreviewRefundEmailRequest as fE, type PreviewRefundEmailResponse as fF, type PreviewCancelEmailRequest as fG, type PreviewCancelEmailResponse as fH, type PreviewCancelRefundEmailRequest as fI, type PreviewCancelRefundEmailResponse as fJ, type PreviewBuyerPaymentsReceivedEmailRequest as fK, type PreviewBuyerPaymentsReceivedEmailResponse as fL, type PreviewBuyerConfirmationEmailRequest as fM, type PreviewBuyerConfirmationEmailResponse as fN, type PreviewBuyerPickupConfirmationEmailRequest as fO, type PreviewBuyerPickupConfirmationEmailResponse as fP, type PreviewShippingConfirmationEmailRequest as fQ, type PreviewShippingConfirmationEmailResponse as fR, type PreviewResendDownloadLinksEmailRequest as fS, type PreviewResendDownloadLinksEmailResponse as fT, type MetaSiteSpecialEvent as fU, type MetaSiteSpecialEventPayloadOneOf as fV, type Asset as fW, type SiteCreated as fX, type SiteTransferred as fY, type SiteDeleted as fZ, type DeleteContext as f_, type CalculateRefundResponse as fa, type CalculateRefundItemResponse as fb, type VoidAuthorizedPaymentsRequest as fc, type CaptureAuthorizedPaymentsRequest as fd, type ChargeSavedPaymentMethodRequest as fe, type ChargeSavedPaymentMethodResponse as ff, type SendBuyerConfirmationEmailRequest as fg, type SendBuyerConfirmationEmailResponse as fh, type SendBuyerPaymentsReceivedEmailRequest as fi, type SendBuyerPaymentsReceivedEmailResponse as fj, type SendBuyerPickupConfirmationEmailRequest as fk, type SendBuyerPickupConfirmationEmailResponse as fl, type BulkSendBuyerPickupConfirmationEmailsRequest as fm, type BulkSendBuyerPickupConfirmationEmailsResponse as fn, type SendBuyerShippingConfirmationEmailRequest as fo, type SendBuyerShippingConfirmationEmailResponse as fp, type BulkSendBuyerShippingConfirmationEmailsRequest as fq, type BulkSendBuyerShippingConfirmationEmailsResponse as fr, type SendMerchantOrderReceivedNotificationRequest as fs, type SendMerchantOrderReceivedNotificationResponse as ft, type SendCancelRefundEmailRequest as fu, type SendCancelRefundEmailResponse as fv, type SendRefundEmailRequest as fw, type SendRefundEmailResponse as fx, type SendFulfillmentEmailRequest as fy, type SendFulfillmentEmailResponse as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type DraftOrderDiffsRecipientUpdateInfoOneOf as g$, type SitePublished as g0, type SiteUnpublished as g1, type SiteMarkedAsTemplate as g2, type SiteMarkedAsWixSite as g3, type ServiceProvisioned as g4, type ServiceRemoved as g5, type SiteRenamed as g6, type SiteHardDeleted as g7, type NamespaceChanged as g8, type StudioAssigned as g9, type PlatformQuery as gA, type PlatformQueryPagingMethodOneOf as gB, type Sorting as gC, type PlatformPaging as gD, type CursorPaging as gE, type InternalQueryOrdersResponse as gF, type PlatformPagingMetadata as gG, type Cursors as gH, type QueryOrderRequest as gI, type QueryOrderResponse as gJ, type SearchOrdersRequest as gK, type CursorSearch as gL, type CursorSearchPagingMethodOneOf as gM, type CursorPagingMetadata as gN, type CreateOrderRequest as gO, type OrderCreationSettings as gP, type OrderCreationSettingsEditableByOneOf as gQ, type OrderCreateNotifications as gR, type CreateOrderResponse as gS, type UpdateOrderRequest as gT, type UpdateOrderResponse as gU, type BulkUpdateOrdersRequest as gV, type CommitDeltasRequest as gW, type DraftOrderDiffs as gX, type DraftOrderDiffsShippingUpdateInfoOneOf as gY, type DraftOrderDiffsBuyerUpdateInfoOneOf as gZ, type DraftOrderDiffsBillingUpdateInfoOneOf as g_, type StudioUnassigned as ga, type SiteUrlChanged as gb, type SitePurgedExternally as gc, type OdeditorAssigned as gd, type OdeditorUnassigned as ge, type PicassoAssigned as gf, type PicassoUnassigned as gg, type WixelAssigned as gh, type WixelUnassigned as gi, type StudioTwoAssigned as gj, type StudioTwoUnassigned as gk, type UserDomainMediaEnabled as gl, type UserDomainMediaDisabled as gm, type EditorlessAssigned as gn, type EditorlessUnassigned as go, type HasCustomEmailConfigurationsRequest as gp, type HasCustomEmailConfigurationsResponse as gq, type AddToAutomationMigrationPopulationRequest as gr, type AddToAutomationMigrationPopulationResponse as gs, type IsInAutomationMigrationPopulationRequest as gt, type IsInAutomationMigrationPopulationResponse as gu, type DiffmatokyPayload as gv, type ErrorInformation as gw, type GetOrderRequest as gx, type GetOrderResponse as gy, type InternalQueryOrdersRequest as gz, type PaymentCapture as h, type UpdateLineItemsDescriptionLinesResponse as h$, type V1LineItemDelta as h0, type V1LineItemDeltaDeltaOneOf as h1, type CommitDeltasResponse as h2, type ArchiveOrderRequest as h3, type ArchiveOrderResponse as h4, type BulkArchiveOrdersRequest as h5, type BulkArchiveOrdersResponse as h6, type BulkArchiveOrdersByFilterRequest as h7, type BulkArchiveOrdersByFilterResponse as h8, type UnArchiveOrderRequest as h9, type OrderCanceled as hA, type DownloadLinkSent as hB, type TrackingNumberAdded as hC, type TrackingNumberEdited as hD, type TrackingLinkAdded as hE, type ShippingConfirmationEmailSent as hF, type InvoiceAdded as hG, type InvoiceSent as hH, type FulfillerEmailSent as hI, type ShippingAddressEdited as hJ, type EmailEdited as hK, type PickupReadyEmailSent as hL, type OrderPartiallyPaid as hM, type OrderPending as hN, type OrderRejected as hO, type AddInternalActivityResponse as hP, type AddActivityRequest as hQ, type PublicActivity as hR, type PublicActivityContentOneOf as hS, type AddActivityResponse as hT, type AddActivitiesRequest as hU, type UpdateActivityRequest as hV, type UpdateActivityResponse as hW, type DeleteActivityRequest as hX, type DeleteActivityResponse as hY, type UpdateLineItemsDescriptionLinesRequest as hZ, type LineItemUpdate as h_, type UnArchiveOrderResponse as ha, type BulkUnArchiveOrdersRequest as hb, type BulkUnArchiveOrdersResponse as hc, type BulkUnArchiveOrdersByFilterRequest as hd, type BulkUnArchiveOrdersByFilterResponse as he, type UpdateBuyerInfoRequest as hf, type BuyerInfoUpdate as hg, type UpdateBuyerInfoResponse as hh, type UpdateBuyerEmailRequest as hi, type UpdateBuyerEmailResponse as hj, type UpdateOrderShippingAddressRequest as hk, type UpdateOrderShippingAddressResponse as hl, type UpdateBillingContactDetailsRequest as hm, type UpdateBillingContactDetailsResponse as hn, type UpdateOrderLineItemRequest as ho, type UpdateOrderLineItemResponse as hp, type UpdateOrderLineItemsRequest as hq, type MaskedOrderLineItem as hr, type UpdateOrderLineItemsResponse as hs, type AddInternalActivityRequest as ht, type InternalActivity as hu, type InternalActivityContentOneOf as hv, type OrderPlaced as hw, type OrderPaid as hx, type OrderFulfilled as hy, type OrderNotFulfilled as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type LineItems as i$, type MarkOrderAsSeenByHumanRequest as i0, type MarkOrderAsSeenByHumanResponse as i1, type CancelOrderRequest as i2, type UpdateOrderStatusRequest as i3, type UpdateOrderStatusResponse as i4, type MarkAsFulfilledRequest as i5, type MarkAsFulfilledResponse as i6, type BulkMarkAsFulfilledRequest as i7, type BulkMarkAsFulfilledResponse as i8, type BulkMarkAsFulfilledByFilterRequest as i9, type TagsTags as iA, type TagsTagList as iB, type BulkUpdateOrderTagsResult as iC, type SendOrderUpdatedDomainEventRequest as iD, type SendOrderUpdatedDomainEventResponse as iE, type Task as iF, type TaskKey as iG, type TaskAction as iH, type TaskActionActionOneOf as iI, type Complete as iJ, type Cancel as iK, type Reschedule as iL, type InvoiceSentEvent as iM, type IdAndVersion as iN, type InvoiceFields as iO, type Customer as iP, type Email as iQ, type QuotesAddress as iR, type AddressDescription as iS, type Phone as iT, type Company as iU, type CommonAddress as iV, type CommonAddressStreetOneOf as iW, type Subdivision as iX, type StandardDetails as iY, type ShippingContactDetails as iZ, type InvoiceDates as i_, type BulkMarkAsFulfilledByFilterResponse as ia, type MarkAsUnfulfilledRequest as ib, type MarkAsUnfulfilledResponse as ic, type BulkMarkAsUnfulfilledRequest as id, type BulkMarkAsUnfulfilledResponse as ie, type BulkMarkAsUnfulfilledByFilterRequest as ig, type BulkMarkAsUnfulfilledByFilterResponse as ih, type BulkSetBusinessLocationRequest as ii, type BulkSetBusinessLocationResponse as ij, type BulkSetBusinessLocationResult as ik, type V1MarkOrderAsPaidRequest as il, type V1MarkOrderAsPaidResponse as im, type V1BulkMarkOrdersAsPaidRequest as io, type V1BulkMarkOrdersAsPaidResponse as ip, type V1CreatePaymentGatewayOrderRequest as iq, type V1CreatePaymentGatewayOrderResponse as ir, type GetShipmentsRequest as is, type GetShipmentsResponse as it, type AggregateOrdersRequest as iu, type AggregateOrdersResponse as iv, type DecrementItemsQuantityRequest as iw, type DecrementData as ix, type DecrementItemsQuantityResponse as iy, type BulkUpdateOrderTagsRequest as iz, type GetOrderApplicationErrors as j, type InventoryActionWithLiterals as j$, type LineItem as j0, type BigDecimalWrapper as j1, type LineItemTax as j2, type Source as j3, type LineItemMetaData as j4, type Locale as j5, type TotalPrice as j6, type ItemizedFee as j7, type Discount as j8, type DiscountOneDiscountTypeOneOf as j9, type ItemTypePresetWithLiterals as jA, type PaymentOptionTypeWithLiterals as jB, type JurisdictionTypeWithLiterals as jC, type SubscriptionFrequencyWithLiterals as jD, type ProductPeriodAlignmentWithLiterals as jE, type AdjustmentTypeWithLiterals as jF, type TaxableAddressTypeWithLiterals as jG, type MeasurementUnitWithLiterals as jH, type PaymentStatusEnumPaymentStatusWithLiterals as jI, type FulfillmentStatusWithLiterals as jJ, type WeightUnitWithLiterals as jK, type VatTypeWithLiterals as jL, type PickupMethodWithLiterals as jM, type OrderStatusWithLiterals as jN, type DiscountTypeWithLiterals as jO, type DiscountReasonWithLiterals as jP, type LineItemQuantityChangeTypeWithLiterals as jQ, type ActivityTypeWithLiterals as jR, type OrderActivityTypeEnumActivityTypeWithLiterals as jS, type AttributionSourceWithLiterals as jT, type ChannelTypeWithLiterals as jU, type AdditionalFeeSourceWithLiterals as jV, type OrderActionTypeWithLiterals as jW, type SpecificItemsCouponBehaviorWithLiterals as jX, type ChargeTypeWithLiterals as jY, type VersioningModeWithLiterals as jZ, type DeltaPaymentOptionTypeWithLiterals as j_, 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 RecordManuallyCollectedPaymentOptions as jm, type PaymentCollectionMarkOrderAsPaidOptions as jn, type PaymentCollectionCreatePaymentGatewayOrderOptions as jo, type ChargeMembershipsOptions as jp, type TriggerRefundOptions as jq, type OrderSearchSpec as jr, type UpdateOrderLineItemIdentifiers as js, type UpdateOrderLineItem as jt, type UpdateActivityIdentifiers as ju, type DeleteActivityIdentifiers as jv, type AggregateOrdersOptions as jw, utils as jx, type DescriptionLineTypeWithLiterals as jy, type DimensionsUnitWithLiterals as jz, type OrderSearch as k, cancelOrder as k$, type WebhookIdentityTypeWithLiterals as k0, type ScheduledActionWithLiterals as k1, type DurationUnitWithLiterals as k2, type PaymentCollectabilityStatusWithLiterals as k3, type PredefinedPaymentMethodWithLiterals as k4, type RefundableStatusWithLiterals as k5, type NonRefundableReasonWithLiterals as k6, type ManuallyRefundableReasonWithLiterals as k7, type RestockTypeWithLiterals as k8, type TransactionStatusWithLiterals as k9, type RecordManuallyCollectedPaymentApplicationErrors as kA, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kB, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kC, type TriggerRefundApplicationErrors as kD, type UpdateOrderStatusApplicationErrors as kE, type CommonSearchWithEntityContext as kF, onOrderApproved as kG, onOrderCanceled as kH, onOrderCommitted as kI, onOrderCreated as kJ, onOrderFulfilled as kK, onOrderImported as kL, onOrderImportedOrderDeleted as kM, onOrderPaymentStatusUpdated as kN, onOrderUpdated as kO, importOrder as kP, setOrderNumberCounter as kQ, bulkDeleteImportedOrders as kR, preparePaymentCollection as kS, getPaymentCollectabilityStatus as kT, voidAuthorizedPayments as kU, captureAuthorizedPayments as kV, getOrder as kW, createOrder as kX, updateOrder as kY, bulkUpdateOrders as kZ, addActivities as k_, type AuthorizationCaptureStatusWithLiterals as ka, type AuthorizationVoidStatusWithLiterals as kb, type ReasonWithLiterals as kc, type ActionTypeWithLiterals as kd, type ChargebackStatusWithLiterals as ke, type MembershipPaymentStatusWithLiterals as kf, type PaymentStatusWithLiterals as kg, type CanceledReasonWithLiterals as kh, type DeclinedReasonWithLiterals as ki, type VoidedReasonWithLiterals as kj, type RefundStatusWithLiterals as kk, type PreviewEmailTypeWithLiterals as kl, type StateWithLiterals as km, type SiteCreatedContextWithLiterals as kn, type NamespaceWithLiterals as ko, type DeleteStatusWithLiterals as kp, type OriginWithLiterals as kq, type SortOrderWithLiterals as kr, type OrderApprovalStrategyWithLiterals as ks, type PlacementWithLiterals as kt, type SubdivisionTypeWithLiterals as ku, type SourceTypeWithLiterals as kv, type CustomFieldGroupWithLiterals as kw, type ValueTypeWithLiterals as kx, type DepositTypeWithLiterals as ky, type InvoiceStatusWithLiterals as kz, type SearchOrdersResponse as l, bulkUpdateOrderTags as l0, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };