@wix/auto_sdk_ecom_orders 1.0.280 → 1.0.281

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