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