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