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