@wix/auto_sdk_ecom_orders 1.0.326 → 1.0.328
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-CioVnQwu.d.ts → ecom-v1-order-orders.universal-BmHEmYb8.d.ts} +1689 -1678
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +80 -82
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +80 -82
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1689 -1678
- package/build/cjs/meta.js +80 -82
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-CioVnQwu.d.mts → ecom-v1-order-orders.universal-BmHEmYb8.d.mts} +1689 -1678
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +80 -82
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +80 -82
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1689 -1678
- package/build/es/meta.mjs +80 -82
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-aVj7Mb1n.d.ts → ecom-v1-order-orders.universal-BAracj8P.d.ts} +1833 -1837
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +1828 -1841
- package/build/internal/es/{ecom-v1-order-orders.universal-aVj7Mb1n.d.mts → ecom-v1-order-orders.universal-BAracj8P.d.mts} +1833 -1837
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +1828 -1841
- package/package.json +4 -4
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { e8 as ImportOrderRequest$1, I as ImportOrderResponse$1, e9 as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ea as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1,
|
|
1
|
+
import { e8 as ImportOrderRequest$1, I as ImportOrderResponse$1, e9 as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ea as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fv as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fz as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fA as RecordManuallyCollectedPaymentRequest$1, fD as RecordManuallyCollectedPaymentResponse$1, fE as MarkOrderAsPaidRequest$1, fF as MarkOrderAsPaidResponse$1, fG as BulkMarkOrdersAsPaidRequest$1, fH as BulkMarkOrdersAsPaidResponse$1, fM as GetRefundabilityStatusRequest$1, fN as GetRefundabilityStatusResponse$1, fQ as CreatePaymentGatewayOrderRequest$1, fS as CreatePaymentGatewayOrderResponse$1, fT as ChargeMembershipsRequest$1, fW as ChargeMembershipsResponse$1, fX as TriggerRefundRequest$1, g0 as TriggerRefundResponse$1, gB as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gC as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gK as GetOrderRequest$1, gL as GetOrderResponse$1, gX as SearchOrdersRequest$1, l as SearchOrdersResponse$1, g$ as CreateOrderRequest$1, h3 as CreateOrderResponse$1, h4 as UpdateOrderRequest$1, h5 as UpdateOrderResponse$1, h6 as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, hB as UpdateOrderLineItemRequest$1, hC as UpdateOrderLineItemResponse$1, i1 as AddActivityRequest$1, i4 as AddActivityResponse$1, i5 as AddActivitiesRequest$1, r as AddActivitiesResponse$1, i6 as UpdateActivityRequest$1, i7 as UpdateActivityResponse$1, i8 as DeleteActivityRequest$1, i9 as DeleteActivityResponse$1, ig as CancelOrderRequest$1, t as CancelOrderResponse$1, ih as UpdateOrderStatusRequest$1, ii as UpdateOrderStatusResponse$1, iH as AggregateOrdersRequest$1, iI as AggregateOrdersResponse$1, iM as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-BmHEmYb8.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -659,6 +659,8 @@ interface LineItemTaxInfo {
|
|
|
659
659
|
* @maxSize 7
|
|
660
660
|
*/
|
|
661
661
|
taxBreakdown?: LineItemTaxBreakdown[];
|
|
662
|
+
/** Amount of the line item price that was exempt from tax. */
|
|
663
|
+
exemptAmount?: Price;
|
|
662
664
|
}
|
|
663
665
|
/**
|
|
664
666
|
* TaxBreakdown represents tax information for a line item.
|
|
@@ -695,6 +697,8 @@ interface LineItemTaxBreakdown {
|
|
|
695
697
|
nonTaxableAmount?: Price;
|
|
696
698
|
/** Taxable amount of the line item price. */
|
|
697
699
|
taxableAmount?: Price;
|
|
700
|
+
/** Amount of the line item price that was exempt from this authority. */
|
|
701
|
+
exemptAmount?: Price;
|
|
698
702
|
}
|
|
699
703
|
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
700
704
|
declare enum JurisdictionType {
|
|
@@ -1650,6 +1654,11 @@ interface OrderTaxInfo {
|
|
|
1650
1654
|
* @readonly
|
|
1651
1655
|
*/
|
|
1652
1656
|
taxExempt?: boolean | null;
|
|
1657
|
+
/**
|
|
1658
|
+
* Total amount exempt from tax calculations.
|
|
1659
|
+
* @readonly
|
|
1660
|
+
*/
|
|
1661
|
+
totalExempt?: Price;
|
|
1653
1662
|
}
|
|
1654
1663
|
/**
|
|
1655
1664
|
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
@@ -1681,6 +1690,8 @@ interface OrderTaxBreakdown {
|
|
|
1681
1690
|
rate?: string;
|
|
1682
1691
|
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1683
1692
|
aggregatedTaxAmount?: Price;
|
|
1693
|
+
/** Total amount exempt from this tax, summed across all line items. */
|
|
1694
|
+
aggregatedExemptAmount?: Price;
|
|
1684
1695
|
}
|
|
1685
1696
|
/** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
|
|
1686
1697
|
interface CrossBorderCalculation {
|
|
@@ -4120,461 +4131,163 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
4120
4131
|
*/
|
|
4121
4132
|
jobId?: string;
|
|
4122
4133
|
}
|
|
4123
|
-
interface
|
|
4134
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
4124
4135
|
/** @format GUID */
|
|
4125
|
-
|
|
4126
|
-
/**
|
|
4127
|
-
* @minLength 1
|
|
4128
|
-
* @maxLength 100
|
|
4129
|
-
* @maxSize 100
|
|
4130
|
-
*/
|
|
4131
|
-
orderIds?: string[];
|
|
4136
|
+
orderId?: string;
|
|
4132
4137
|
}
|
|
4133
|
-
interface
|
|
4138
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
4134
4139
|
}
|
|
4135
|
-
interface
|
|
4136
|
-
/** @format GUID */
|
|
4137
|
-
metasiteId?: string;
|
|
4140
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
4138
4141
|
/**
|
|
4139
4142
|
* @minLength 1
|
|
4140
4143
|
* @maxLength 100
|
|
4141
4144
|
*/
|
|
4142
4145
|
orderId?: string;
|
|
4143
4146
|
}
|
|
4144
|
-
interface
|
|
4147
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
4148
|
+
}
|
|
4149
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
4145
4150
|
/**
|
|
4146
|
-
* Ecom order ID.
|
|
4147
4151
|
* @minLength 1
|
|
4148
4152
|
* @maxLength 100
|
|
4149
4153
|
*/
|
|
4150
|
-
|
|
4151
|
-
/** Amount to collect */
|
|
4152
|
-
amount: Price;
|
|
4153
|
-
/**
|
|
4154
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4155
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
4156
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4157
|
-
*/
|
|
4158
|
-
paymentGatewayOrderId?: string | null;
|
|
4159
|
-
/**
|
|
4160
|
-
* Whether to delay capture of the payment.
|
|
4161
|
-
* Default: false
|
|
4162
|
-
* @deprecated Whether to delay capture of the payment.
|
|
4163
|
-
* Default: false
|
|
4164
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4165
|
-
* @targetRemovalDate 2024-09-30
|
|
4166
|
-
*/
|
|
4167
|
-
delayedCapture?: boolean;
|
|
4168
|
-
/** Delayed capture payment settings */
|
|
4169
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4154
|
+
orderId?: string;
|
|
4170
4155
|
}
|
|
4171
|
-
interface
|
|
4172
|
-
|
|
4173
|
-
|
|
4174
|
-
* @format WEB_URL
|
|
4175
|
-
*/
|
|
4176
|
-
successUrl?: string | null;
|
|
4177
|
-
/**
|
|
4178
|
-
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4179
|
-
* @format WEB_URL
|
|
4180
|
-
*/
|
|
4181
|
-
cancelUrl?: string | null;
|
|
4156
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
4157
|
+
}
|
|
4158
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
4182
4159
|
/**
|
|
4183
|
-
*
|
|
4184
|
-
* @
|
|
4160
|
+
* IDs of orders to send pickup emails for.
|
|
4161
|
+
* @minSize 1
|
|
4162
|
+
* @maxSize 300
|
|
4185
4163
|
*/
|
|
4186
|
-
|
|
4164
|
+
orderIds?: string[];
|
|
4165
|
+
}
|
|
4166
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
4167
|
+
}
|
|
4168
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
4187
4169
|
/**
|
|
4188
|
-
*
|
|
4189
|
-
* @
|
|
4170
|
+
* @minLength 1
|
|
4171
|
+
* @maxLength 100
|
|
4190
4172
|
*/
|
|
4191
|
-
|
|
4192
|
-
}
|
|
4193
|
-
interface DelayedCaptureSettings {
|
|
4194
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4195
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
4196
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4197
|
-
delayDuration?: Duration;
|
|
4173
|
+
orderId?: string;
|
|
4198
4174
|
}
|
|
4199
|
-
|
|
4200
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
4201
|
-
VOID = "VOID",
|
|
4202
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
4203
|
-
CAPTURE = "CAPTURE"
|
|
4175
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
4204
4176
|
}
|
|
4205
|
-
|
|
4206
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4207
|
-
interface Duration {
|
|
4177
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
4208
4178
|
/**
|
|
4209
|
-
*
|
|
4210
|
-
* @
|
|
4179
|
+
* IDs of orders to send pickup emails for.
|
|
4180
|
+
* @minSize 1
|
|
4181
|
+
* @maxSize 300
|
|
4211
4182
|
*/
|
|
4212
|
-
|
|
4213
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4214
|
-
unit?: DurationUnitWithLiterals;
|
|
4215
|
-
}
|
|
4216
|
-
declare enum DurationUnit {
|
|
4217
|
-
MINUTES = "MINUTES",
|
|
4218
|
-
HOURS = "HOURS",
|
|
4219
|
-
DAYS = "DAYS"
|
|
4183
|
+
orderIds?: string[];
|
|
4220
4184
|
}
|
|
4221
|
-
|
|
4222
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4223
|
-
interface PreparePaymentCollectionResponse {
|
|
4224
|
-
/** Payment gateway order id which is associated with given payment */
|
|
4225
|
-
paymentGatewayOrderId?: string;
|
|
4185
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
4226
4186
|
}
|
|
4227
|
-
interface
|
|
4187
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
4228
4188
|
/**
|
|
4229
|
-
* Ecom order ID.
|
|
4230
4189
|
* @minLength 1
|
|
4231
4190
|
* @maxLength 100
|
|
4232
4191
|
*/
|
|
4233
|
-
|
|
4234
|
-
}
|
|
4235
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
4236
|
-
/** Payment collectability status */
|
|
4237
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4238
|
-
/** Collectable order amount */
|
|
4239
|
-
amount?: Price;
|
|
4192
|
+
orderId?: string;
|
|
4240
4193
|
}
|
|
4241
|
-
|
|
4242
|
-
UNKNOWN = "UNKNOWN",
|
|
4243
|
-
COLLECTABLE = "COLLECTABLE",
|
|
4244
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4245
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4246
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4247
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4248
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4249
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4250
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4251
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4252
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4253
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
4254
|
-
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
4194
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
4255
4195
|
}
|
|
4256
|
-
|
|
4257
|
-
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
|
|
4258
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
4196
|
+
interface SendCancelRefundEmailRequest {
|
|
4259
4197
|
/**
|
|
4260
|
-
*
|
|
4198
|
+
* The ID of order that is canceled/refunded
|
|
4261
4199
|
* @minLength 1
|
|
4262
4200
|
* @maxLength 100
|
|
4263
4201
|
*/
|
|
4264
|
-
orderId
|
|
4265
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
4266
|
-
amount: Price;
|
|
4267
|
-
}
|
|
4268
|
-
/**
|
|
4269
|
-
* User-defined payment method name.
|
|
4270
|
-
* Allows specifying either a predefined type or a custom name.
|
|
4271
|
-
*/
|
|
4272
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4273
|
-
/** Predefined payment method. */
|
|
4274
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4202
|
+
orderId?: string;
|
|
4275
4203
|
/**
|
|
4276
|
-
*
|
|
4277
|
-
*
|
|
4278
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4204
|
+
* Personal note added to the email (optional)
|
|
4279
4205
|
* @minLength 1
|
|
4280
|
-
* @maxLength
|
|
4206
|
+
* @maxLength 1000
|
|
4281
4207
|
*/
|
|
4282
|
-
|
|
4208
|
+
customMessage?: string | null;
|
|
4209
|
+
/** Refund amount */
|
|
4210
|
+
refundAmount?: Price;
|
|
4211
|
+
/**
|
|
4212
|
+
* Refund ID. (Optional)
|
|
4213
|
+
* @format GUID
|
|
4214
|
+
*/
|
|
4215
|
+
refundId?: string | null;
|
|
4283
4216
|
}
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4217
|
+
interface SendCancelRefundEmailResponse {
|
|
4218
|
+
}
|
|
4219
|
+
interface SendRefundEmailRequest {
|
|
4288
4220
|
/**
|
|
4289
|
-
*
|
|
4290
|
-
*
|
|
4291
|
-
|
|
4221
|
+
* The ID of order that is refunded
|
|
4222
|
+
* @format GUID
|
|
4223
|
+
*/
|
|
4224
|
+
orderId?: string;
|
|
4225
|
+
/**
|
|
4226
|
+
* Refund ID
|
|
4227
|
+
* @format GUID
|
|
4228
|
+
*/
|
|
4229
|
+
refundId?: string;
|
|
4230
|
+
/**
|
|
4231
|
+
* Personal note added to the email (optional)
|
|
4292
4232
|
* @minLength 1
|
|
4293
|
-
* @maxLength
|
|
4233
|
+
* @maxLength 1000
|
|
4294
4234
|
*/
|
|
4295
|
-
|
|
4235
|
+
customMessage?: string | null;
|
|
4296
4236
|
}
|
|
4297
|
-
|
|
4298
|
-
declare enum PredefinedPaymentMethod {
|
|
4299
|
-
/** Cash payment. */
|
|
4300
|
-
CASH = "CASH",
|
|
4301
|
-
/** Bank transfer. */
|
|
4302
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4303
|
-
/** Payment by check. */
|
|
4304
|
-
CHECK = "CHECK"
|
|
4237
|
+
interface SendRefundEmailResponse {
|
|
4305
4238
|
}
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
|
|
4239
|
+
interface SendFulfillmentEmailRequest {
|
|
4240
|
+
/** @format GUID */
|
|
4241
|
+
orderId?: string;
|
|
4242
|
+
/** @format GUID */
|
|
4243
|
+
fulfillerId?: string;
|
|
4309
4244
|
}
|
|
4310
|
-
interface
|
|
4245
|
+
interface SendFulfillmentEmailResponse {
|
|
4246
|
+
}
|
|
4247
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
4311
4248
|
/**
|
|
4312
|
-
* Ecom order ID.
|
|
4313
4249
|
* @minLength 1
|
|
4314
4250
|
* @maxLength 100
|
|
4315
4251
|
*/
|
|
4316
|
-
|
|
4252
|
+
orderId?: string;
|
|
4317
4253
|
}
|
|
4318
|
-
interface
|
|
4319
|
-
/** Updated order. */
|
|
4320
|
-
order?: Order;
|
|
4254
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
4321
4255
|
}
|
|
4322
|
-
interface
|
|
4256
|
+
interface PreviewEmailByTypeRequest {
|
|
4257
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
4258
|
+
}
|
|
4259
|
+
declare enum PreviewEmailType {
|
|
4260
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
4261
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
4262
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
4263
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4264
|
+
}
|
|
4265
|
+
/** @enumType */
|
|
4266
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
4267
|
+
interface PreviewEmailByTypeResponse {
|
|
4268
|
+
emailPreview?: string;
|
|
4269
|
+
}
|
|
4270
|
+
interface PreviewRefundEmailRequest {
|
|
4323
4271
|
/**
|
|
4324
|
-
* IDs of orders to mark as paid.
|
|
4325
|
-
* @minSize 1
|
|
4326
|
-
* @maxSize 100
|
|
4327
4272
|
* @minLength 1
|
|
4328
4273
|
* @maxLength 100
|
|
4329
4274
|
*/
|
|
4330
|
-
|
|
4331
|
-
|
|
4332
|
-
|
|
4275
|
+
orderId?: string;
|
|
4276
|
+
/** Refund amount */
|
|
4277
|
+
refundAmount?: Price;
|
|
4278
|
+
/** Refund business details */
|
|
4279
|
+
details?: RefundDetails;
|
|
4333
4280
|
/**
|
|
4334
|
-
*
|
|
4335
|
-
*
|
|
4281
|
+
* Personal note added to the email (optional)
|
|
4282
|
+
* @minLength 1
|
|
4283
|
+
* @maxLength 1000
|
|
4336
4284
|
*/
|
|
4337
|
-
|
|
4338
|
-
/** Bulk action metadata. */
|
|
4339
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4340
|
-
}
|
|
4341
|
-
interface BulkOrderResult {
|
|
4342
|
-
/** Item metadata. */
|
|
4343
|
-
itemMetadata?: ItemMetadata;
|
|
4344
|
-
/**
|
|
4345
|
-
* Updated order.
|
|
4346
|
-
*
|
|
4347
|
-
* Returned when `returnFullEntity = true`.
|
|
4348
|
-
*/
|
|
4349
|
-
item?: Order;
|
|
4350
|
-
}
|
|
4351
|
-
interface ItemMetadata {
|
|
4352
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4353
|
-
id?: string | null;
|
|
4354
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4355
|
-
originalIndex?: number;
|
|
4356
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4357
|
-
success?: boolean;
|
|
4358
|
-
/** Details about the error in case of failure. */
|
|
4359
|
-
error?: ApplicationError;
|
|
4360
|
-
}
|
|
4361
|
-
interface ApplicationError {
|
|
4362
|
-
/** Error code. */
|
|
4363
|
-
code?: string;
|
|
4364
|
-
/** Description of the error. */
|
|
4365
|
-
description?: string;
|
|
4366
|
-
/** Data related to the error. */
|
|
4367
|
-
data?: Record<string, any> | null;
|
|
4368
|
-
}
|
|
4369
|
-
interface BulkActionMetadata {
|
|
4370
|
-
/** Number of items that were successfully processed. */
|
|
4371
|
-
totalSuccesses?: number;
|
|
4372
|
-
/** Number of items that couldn't be processed. */
|
|
4373
|
-
totalFailures?: number;
|
|
4374
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4375
|
-
undetailedFailures?: number;
|
|
4376
|
-
}
|
|
4377
|
-
interface GetRefundabilityStatusRequest {
|
|
4378
|
-
/**
|
|
4379
|
-
* Order ID.
|
|
4380
|
-
* @minLength 1
|
|
4381
|
-
* @maxLength 100
|
|
4382
|
-
*/
|
|
4383
|
-
ecomOrderId: string;
|
|
4384
|
-
}
|
|
4385
|
-
interface GetRefundabilityStatusResponse {
|
|
4386
|
-
/**
|
|
4387
|
-
* Refundability details.
|
|
4388
|
-
* @maxSize 300
|
|
4389
|
-
*/
|
|
4390
|
-
refundabilities?: Refundability[];
|
|
4391
|
-
/**
|
|
4392
|
-
* Whether the order supports refunding per item.
|
|
4393
|
-
* @deprecated
|
|
4394
|
-
*/
|
|
4395
|
-
refundablePerItem?: boolean;
|
|
4396
|
-
}
|
|
4397
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4398
|
-
/** Reason why payment is not refundable. */
|
|
4399
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4400
|
-
/** Reason why payment is only refundable manually. */
|
|
4401
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4402
|
-
/** Payment ID. */
|
|
4403
|
-
paymentId?: string;
|
|
4404
|
-
/** Payment refundability status. */
|
|
4405
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4406
|
-
/** Link to payment provider dashboard. */
|
|
4407
|
-
providerLink?: string | null;
|
|
4408
|
-
}
|
|
4409
|
-
/** @oneof */
|
|
4410
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4411
|
-
/** Reason why payment is not refundable. */
|
|
4412
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4413
|
-
/** Reason why payment is only refundable manually. */
|
|
4414
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4415
|
-
}
|
|
4416
|
-
declare enum RefundableStatus {
|
|
4417
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4418
|
-
MANUAL = "MANUAL",
|
|
4419
|
-
REFUNDABLE = "REFUNDABLE"
|
|
4420
|
-
}
|
|
4421
|
-
/** @enumType */
|
|
4422
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4423
|
-
declare enum NonRefundableReason {
|
|
4424
|
-
NONE = "NONE",
|
|
4425
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4426
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4427
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4428
|
-
NOT_PAID = "NOT_PAID",
|
|
4429
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4430
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
4431
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4432
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
4433
|
-
FORBIDDEN = "FORBIDDEN",
|
|
4434
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4435
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4436
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4437
|
-
}
|
|
4438
|
-
/** @enumType */
|
|
4439
|
-
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';
|
|
4440
|
-
declare enum ManuallyRefundableReason {
|
|
4441
|
-
EXPIRED = "EXPIRED",
|
|
4442
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4443
|
-
OFFLINE = "OFFLINE",
|
|
4444
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4445
|
-
}
|
|
4446
|
-
/** @enumType */
|
|
4447
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4448
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
4449
|
-
/**
|
|
4450
|
-
* Ecom order ID.
|
|
4451
|
-
* @minLength 1
|
|
4452
|
-
* @maxLength 100
|
|
4453
|
-
*/
|
|
4454
|
-
ecomOrderId: string;
|
|
4455
|
-
/** Information about the user who initiated the payment. */
|
|
4456
|
-
chargedBy?: ChargedBy;
|
|
4457
|
-
}
|
|
4458
|
-
interface ChargedBy {
|
|
4459
|
-
/**
|
|
4460
|
-
* ID - id of the user who initiated the payment
|
|
4461
|
-
* @format GUID
|
|
4462
|
-
*/
|
|
4463
|
-
id?: string;
|
|
4464
|
-
/**
|
|
4465
|
-
* Full name - name of the user who initiated the payment
|
|
4466
|
-
* @minLength 1
|
|
4467
|
-
* @maxLength 200
|
|
4468
|
-
*/
|
|
4469
|
-
fullName?: string | null;
|
|
4470
|
-
}
|
|
4471
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
4472
|
-
/** ID of the order created in the payment gateway */
|
|
4473
|
-
paymentGatewayOrderId?: string;
|
|
4474
|
-
}
|
|
4475
|
-
interface ChargeMembershipsRequest {
|
|
4476
|
-
/**
|
|
4477
|
-
* Order ID.
|
|
4478
|
-
* @minLength 1
|
|
4479
|
-
* @maxLength 100
|
|
4480
|
-
*/
|
|
4481
|
-
ecomOrderId: string;
|
|
4482
|
-
/**
|
|
4483
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4484
|
-
* but a user which is using the membership on behalf of the a member
|
|
4485
|
-
* @format GUID
|
|
4486
|
-
*/
|
|
4487
|
-
memberId: string;
|
|
4488
|
-
/**
|
|
4489
|
-
* List of items to be paid by memberships
|
|
4490
|
-
* @minSize 1
|
|
4491
|
-
* @maxSize 300
|
|
4492
|
-
*/
|
|
4493
|
-
membershipCharges?: MembershipChargeItem[];
|
|
4494
|
-
}
|
|
4495
|
-
interface MembershipChargeItem {
|
|
4496
|
-
/**
|
|
4497
|
-
* The id of used membership
|
|
4498
|
-
* @minLength 1
|
|
4499
|
-
* @maxLength 100
|
|
4500
|
-
*/
|
|
4501
|
-
membershipId?: string;
|
|
4502
|
-
/**
|
|
4503
|
-
* ID of the application providing this payment option
|
|
4504
|
-
* @format GUID
|
|
4505
|
-
*/
|
|
4506
|
-
appId?: string;
|
|
4507
|
-
/** The name of used membership */
|
|
4508
|
-
membershipName?: MembershipName;
|
|
4509
|
-
/** Additional data about this membership */
|
|
4510
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
4511
|
-
/** Catalog and item reference info. */
|
|
4512
|
-
catalogReference?: CatalogReference;
|
|
4513
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4514
|
-
serviceProperties?: ServiceProperties;
|
|
4515
|
-
/**
|
|
4516
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
4517
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4518
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4519
|
-
* @minLength 1
|
|
4520
|
-
* @maxLength 36
|
|
4521
|
-
*/
|
|
4522
|
-
rootCatalogItemId?: string | null;
|
|
4523
|
-
/**
|
|
4524
|
-
* line item id of Checkout/Order line item
|
|
4525
|
-
* @minLength 1
|
|
4526
|
-
* @maxLength 100
|
|
4527
|
-
*/
|
|
4528
|
-
lineItemId?: string;
|
|
4529
|
-
}
|
|
4530
|
-
interface MembershipName {
|
|
4531
|
-
/**
|
|
4532
|
-
* Membership name in the site's original language.
|
|
4533
|
-
* @maxLength 100
|
|
4534
|
-
*/
|
|
4535
|
-
original?: string;
|
|
4536
|
-
/**
|
|
4537
|
-
* Membership name translated into the buyer's language.
|
|
4538
|
-
*
|
|
4539
|
-
* Default: The value of `original`
|
|
4540
|
-
* @maxLength 100
|
|
4541
|
-
*/
|
|
4542
|
-
translated?: string | null;
|
|
4543
|
-
}
|
|
4544
|
-
interface ChargeMembershipsResponse {
|
|
4545
|
-
}
|
|
4546
|
-
interface TriggerRefundRequest {
|
|
4547
|
-
/**
|
|
4548
|
-
* The order this refund related to
|
|
4549
|
-
* @minLength 1
|
|
4550
|
-
* @maxLength 100
|
|
4551
|
-
*/
|
|
4552
|
-
ecomOrderId: string;
|
|
4553
|
-
/**
|
|
4554
|
-
* Refund operations information
|
|
4555
|
-
* @minSize 1
|
|
4556
|
-
* @maxSize 1
|
|
4557
|
-
*/
|
|
4558
|
-
payments: PaymentRefund[];
|
|
4559
|
-
/** Business model of a refund */
|
|
4560
|
-
details?: RefundDetails;
|
|
4561
|
-
/** Side effect details related to refund */
|
|
4562
|
-
sideEffects?: RefundSideEffects;
|
|
4563
|
-
}
|
|
4564
|
-
interface PaymentRefund {
|
|
4285
|
+
customMessage?: string | null;
|
|
4565
4286
|
/**
|
|
4566
|
-
*
|
|
4287
|
+
* Refund ID. (Optional)
|
|
4567
4288
|
* @format GUID
|
|
4568
4289
|
*/
|
|
4569
|
-
|
|
4570
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
4571
|
-
amount?: Price;
|
|
4572
|
-
/**
|
|
4573
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
4574
|
-
* 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.
|
|
4575
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
4576
|
-
*/
|
|
4577
|
-
externalRefund?: boolean;
|
|
4290
|
+
refundId?: string | null;
|
|
4578
4291
|
}
|
|
4579
4292
|
/** Business model of a refund request */
|
|
4580
4293
|
interface RefundDetails {
|
|
@@ -4651,1645 +4364,1943 @@ interface ShippingRefund {
|
|
|
4651
4364
|
*/
|
|
4652
4365
|
amount?: Price;
|
|
4653
4366
|
}
|
|
4654
|
-
interface
|
|
4655
|
-
|
|
4656
|
-
|
|
4657
|
-
|
|
4658
|
-
sendOrderRefundedEmail?: boolean;
|
|
4367
|
+
interface PreviewRefundEmailResponse {
|
|
4368
|
+
emailPreview?: string;
|
|
4369
|
+
}
|
|
4370
|
+
interface PreviewCancelEmailRequest {
|
|
4659
4371
|
/**
|
|
4660
|
-
* Custom message added to the refund confirmation email.
|
|
4661
4372
|
* @minLength 1
|
|
4662
|
-
* @maxLength
|
|
4373
|
+
* @maxLength 100
|
|
4663
4374
|
*/
|
|
4664
|
-
|
|
4665
|
-
|
|
4666
|
-
|
|
4667
|
-
|
|
4668
|
-
|
|
4375
|
+
orderId?: string;
|
|
4376
|
+
/**
|
|
4377
|
+
* Personal note added to the email (optional)
|
|
4378
|
+
* @minLength 1
|
|
4379
|
+
* @maxLength 1000
|
|
4380
|
+
*/
|
|
4381
|
+
customMessage?: string | null;
|
|
4382
|
+
}
|
|
4383
|
+
interface PreviewCancelEmailResponse {
|
|
4384
|
+
emailPreview?: string;
|
|
4385
|
+
}
|
|
4386
|
+
interface PreviewCancelRefundEmailRequest {
|
|
4387
|
+
/**
|
|
4388
|
+
* @minLength 1
|
|
4389
|
+
* @maxLength 100
|
|
4390
|
+
*/
|
|
4391
|
+
orderId?: string;
|
|
4392
|
+
/**
|
|
4393
|
+
* Personal note added to the email (optional)
|
|
4394
|
+
* @minLength 1
|
|
4395
|
+
* @maxLength 1000
|
|
4396
|
+
*/
|
|
4397
|
+
customMessage?: string | null;
|
|
4398
|
+
/** Refund amount */
|
|
4399
|
+
refundAmount?: Price;
|
|
4400
|
+
/**
|
|
4401
|
+
* Refund ID. (Optional)
|
|
4402
|
+
* @format GUID
|
|
4403
|
+
*/
|
|
4404
|
+
refundId?: string | null;
|
|
4405
|
+
}
|
|
4406
|
+
interface PreviewCancelRefundEmailResponse {
|
|
4407
|
+
emailPreview?: string;
|
|
4408
|
+
}
|
|
4409
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
4410
|
+
}
|
|
4411
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4412
|
+
emailPreview?: string;
|
|
4413
|
+
}
|
|
4414
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
4415
|
+
}
|
|
4416
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
4417
|
+
emailPreview?: string;
|
|
4418
|
+
}
|
|
4419
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4420
|
+
}
|
|
4421
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4422
|
+
emailPreview?: string;
|
|
4423
|
+
}
|
|
4424
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
4425
|
+
}
|
|
4426
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
4427
|
+
emailPreview?: string;
|
|
4428
|
+
}
|
|
4429
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
4430
|
+
}
|
|
4431
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
4432
|
+
emailPreview?: string;
|
|
4433
|
+
}
|
|
4434
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4435
|
+
/** Emitted on a meta site creation. */
|
|
4436
|
+
siteCreated?: SiteCreated;
|
|
4437
|
+
/** Emitted on a meta site transfer completion. */
|
|
4438
|
+
siteTransferred?: SiteTransferred;
|
|
4439
|
+
/** Emitted on a meta site deletion. */
|
|
4440
|
+
siteDeleted?: SiteDeleted;
|
|
4441
|
+
/** Emitted on a meta site restoration. */
|
|
4442
|
+
siteUndeleted?: SiteUndeleted;
|
|
4443
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4444
|
+
sitePublished?: SitePublished;
|
|
4445
|
+
/** Emitted on a meta site unpublish. */
|
|
4446
|
+
siteUnpublished?: SiteUnpublished;
|
|
4447
|
+
/** Emitted when meta site is marked as template. */
|
|
4448
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4449
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4450
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4451
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4452
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4453
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4454
|
+
serviceRemoved?: ServiceRemoved;
|
|
4455
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4456
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4457
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4458
|
+
hardDeleted?: SiteHardDeleted;
|
|
4459
|
+
/** Emitted on a namespace change. */
|
|
4460
|
+
namespaceChanged?: NamespaceChanged;
|
|
4461
|
+
/** Emitted when Studio is attached. */
|
|
4462
|
+
studioAssigned?: StudioAssigned;
|
|
4463
|
+
/** Emitted when Studio is detached. */
|
|
4464
|
+
studioUnassigned?: StudioUnassigned;
|
|
4465
|
+
/**
|
|
4466
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4467
|
+
* the actual URL.
|
|
4468
|
+
*
|
|
4469
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4470
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4471
|
+
*/
|
|
4472
|
+
urlChanged?: SiteUrlChanged;
|
|
4473
|
+
/** Site is marked as PurgedExternally */
|
|
4474
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4475
|
+
/** Emitted when Odeditor is attached. */
|
|
4476
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4477
|
+
/** Emitted when Odeditor is detached. */
|
|
4478
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4479
|
+
/** Emitted when Picasso is attached. */
|
|
4480
|
+
picassoAssigned?: PicassoAssigned;
|
|
4481
|
+
/** Emitted when Picasso is detached. */
|
|
4482
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4483
|
+
/** Emitted when Wixel is attached. */
|
|
4484
|
+
wixelAssigned?: WixelAssigned;
|
|
4485
|
+
/** Emitted when Wixel is detached. */
|
|
4486
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4487
|
+
/** Emitted when StudioTwo is attached. */
|
|
4488
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4489
|
+
/** Emitted when StudioTwo is detached. */
|
|
4490
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4491
|
+
/** Emitted when media from user domain is enabled. */
|
|
4492
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4493
|
+
/** Emitted when media from user domain is disabled. */
|
|
4494
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4495
|
+
/** Emitted when Editorless is attached. */
|
|
4496
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4497
|
+
/** Emitted when Editorless is detached. */
|
|
4498
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4499
|
+
/**
|
|
4500
|
+
* A meta site id.
|
|
4501
|
+
* @format GUID
|
|
4502
|
+
*/
|
|
4503
|
+
metaSiteId?: string;
|
|
4504
|
+
/** A meta site version. Monotonically increasing. */
|
|
4505
|
+
version?: string;
|
|
4506
|
+
/** A timestamp of the event. */
|
|
4507
|
+
timestamp?: string;
|
|
4508
|
+
/**
|
|
4509
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4510
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4511
|
+
* @maxSize 4000
|
|
4512
|
+
*/
|
|
4513
|
+
assets?: Asset[];
|
|
4514
|
+
}
|
|
4515
|
+
/** @oneof */
|
|
4516
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4517
|
+
/** Emitted on a meta site creation. */
|
|
4518
|
+
siteCreated?: SiteCreated;
|
|
4519
|
+
/** Emitted on a meta site transfer completion. */
|
|
4520
|
+
siteTransferred?: SiteTransferred;
|
|
4521
|
+
/** Emitted on a meta site deletion. */
|
|
4522
|
+
siteDeleted?: SiteDeleted;
|
|
4523
|
+
/** Emitted on a meta site restoration. */
|
|
4524
|
+
siteUndeleted?: SiteUndeleted;
|
|
4525
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4526
|
+
sitePublished?: SitePublished;
|
|
4527
|
+
/** Emitted on a meta site unpublish. */
|
|
4528
|
+
siteUnpublished?: SiteUnpublished;
|
|
4529
|
+
/** Emitted when meta site is marked as template. */
|
|
4530
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4531
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4532
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4533
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4534
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4535
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4536
|
+
serviceRemoved?: ServiceRemoved;
|
|
4537
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4538
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4539
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4540
|
+
hardDeleted?: SiteHardDeleted;
|
|
4541
|
+
/** Emitted on a namespace change. */
|
|
4542
|
+
namespaceChanged?: NamespaceChanged;
|
|
4543
|
+
/** Emitted when Studio is attached. */
|
|
4544
|
+
studioAssigned?: StudioAssigned;
|
|
4545
|
+
/** Emitted when Studio is detached. */
|
|
4546
|
+
studioUnassigned?: StudioUnassigned;
|
|
4547
|
+
/**
|
|
4548
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4549
|
+
* the actual URL.
|
|
4550
|
+
*
|
|
4551
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4552
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4553
|
+
*/
|
|
4554
|
+
urlChanged?: SiteUrlChanged;
|
|
4555
|
+
/** Site is marked as PurgedExternally */
|
|
4556
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4557
|
+
/** Emitted when Odeditor is attached. */
|
|
4558
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4559
|
+
/** Emitted when Odeditor is detached. */
|
|
4560
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4561
|
+
/** Emitted when Picasso is attached. */
|
|
4562
|
+
picassoAssigned?: PicassoAssigned;
|
|
4563
|
+
/** Emitted when Picasso is detached. */
|
|
4564
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4565
|
+
/** Emitted when Wixel is attached. */
|
|
4566
|
+
wixelAssigned?: WixelAssigned;
|
|
4567
|
+
/** Emitted when Wixel is detached. */
|
|
4568
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4569
|
+
/** Emitted when StudioTwo is attached. */
|
|
4570
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4571
|
+
/** Emitted when StudioTwo is detached. */
|
|
4572
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4573
|
+
/** Emitted when media from user domain is enabled. */
|
|
4574
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4575
|
+
/** Emitted when media from user domain is disabled. */
|
|
4576
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4577
|
+
/** Emitted when Editorless is attached. */
|
|
4578
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4579
|
+
/** Emitted when Editorless is detached. */
|
|
4580
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4581
|
+
}
|
|
4582
|
+
interface Asset {
|
|
4583
|
+
/**
|
|
4584
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4585
|
+
* @maxLength 36
|
|
4586
|
+
*/
|
|
4587
|
+
appDefId?: string;
|
|
4588
|
+
/**
|
|
4589
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
4590
|
+
* @maxLength 200
|
|
4591
|
+
*/
|
|
4592
|
+
instanceId?: string;
|
|
4593
|
+
/** An application state. */
|
|
4594
|
+
state?: StateWithLiterals;
|
|
4595
|
+
}
|
|
4596
|
+
declare enum State {
|
|
4597
|
+
UNKNOWN = "UNKNOWN",
|
|
4598
|
+
ENABLED = "ENABLED",
|
|
4599
|
+
DISABLED = "DISABLED",
|
|
4600
|
+
PENDING = "PENDING",
|
|
4601
|
+
DEMO = "DEMO"
|
|
4602
|
+
}
|
|
4603
|
+
/** @enumType */
|
|
4604
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
4605
|
+
interface SiteCreated {
|
|
4606
|
+
/**
|
|
4607
|
+
* A template identifier (empty if not created from a template).
|
|
4608
|
+
* @maxLength 36
|
|
4609
|
+
*/
|
|
4610
|
+
originTemplateId?: string;
|
|
4611
|
+
/**
|
|
4612
|
+
* An account id of the owner.
|
|
4613
|
+
* @format GUID
|
|
4614
|
+
*/
|
|
4615
|
+
ownerId?: string;
|
|
4616
|
+
/** A context in which meta site was created. */
|
|
4617
|
+
context?: SiteCreatedContextWithLiterals;
|
|
4618
|
+
/**
|
|
4619
|
+
* A meta site id from which this site was created.
|
|
4620
|
+
*
|
|
4621
|
+
* In case of a creation from a template it's a template id.
|
|
4622
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4623
|
+
* @format GUID
|
|
4624
|
+
*/
|
|
4625
|
+
originMetaSiteId?: string | null;
|
|
4626
|
+
/**
|
|
4627
|
+
* A meta site name (URL slug).
|
|
4628
|
+
* @maxLength 20
|
|
4629
|
+
*/
|
|
4630
|
+
siteName?: string;
|
|
4631
|
+
/** A namespace. */
|
|
4632
|
+
namespace?: NamespaceWithLiterals;
|
|
4633
|
+
}
|
|
4634
|
+
declare enum SiteCreatedContext {
|
|
4635
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4636
|
+
OTHER = "OTHER",
|
|
4637
|
+
/** A meta site was created from template. */
|
|
4638
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4639
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
4640
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4641
|
+
/** A copy of existing meta site. */
|
|
4642
|
+
DUPLICATE = "DUPLICATE",
|
|
4643
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4644
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4645
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
4646
|
+
FLASH = "FLASH"
|
|
4647
|
+
}
|
|
4648
|
+
/** @enumType */
|
|
4649
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4650
|
+
declare enum Namespace {
|
|
4651
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4652
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4653
|
+
WIX = "WIX",
|
|
4654
|
+
/** 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. */
|
|
4655
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
4656
|
+
/** 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. */
|
|
4657
|
+
ALBUMS = "ALBUMS",
|
|
4658
|
+
/** 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. */
|
|
4659
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4660
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4661
|
+
HOTELS = "HOTELS",
|
|
4662
|
+
/** 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. */
|
|
4663
|
+
CLUBS = "CLUBS",
|
|
4664
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4665
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4669
4666
|
/**
|
|
4670
|
-
*
|
|
4671
|
-
*
|
|
4667
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
4668
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
4672
4669
|
*/
|
|
4673
|
-
|
|
4674
|
-
|
|
4675
|
-
|
|
4676
|
-
|
|
4677
|
-
|
|
4678
|
-
|
|
4679
|
-
|
|
4680
|
-
/**
|
|
4681
|
-
|
|
4682
|
-
interface RestockItem {
|
|
4670
|
+
DEV_SITE = "DEV_SITE",
|
|
4671
|
+
/** 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. */
|
|
4672
|
+
LOGOS = "LOGOS",
|
|
4673
|
+
/** 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. */
|
|
4674
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4675
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4676
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4677
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4678
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4683
4679
|
/**
|
|
4684
|
-
*
|
|
4685
|
-
*
|
|
4680
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
4681
|
+
*
|
|
4682
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4686
4683
|
*/
|
|
4687
|
-
|
|
4684
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
4688
4685
|
/**
|
|
4689
|
-
*
|
|
4690
|
-
*
|
|
4691
|
-
*
|
|
4686
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
4687
|
+
* Will be accessible from Site List and will not have a website app.
|
|
4688
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4692
4689
|
*/
|
|
4693
|
-
|
|
4694
|
-
|
|
4695
|
-
|
|
4696
|
-
/**
|
|
4697
|
-
|
|
4698
|
-
/**
|
|
4699
|
-
|
|
4700
|
-
/**
|
|
4701
|
-
|
|
4702
|
-
}
|
|
4703
|
-
/**
|
|
4704
|
-
* A record of all payments and refunds associated with an order.
|
|
4705
|
-
*
|
|
4706
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
4707
|
-
*/
|
|
4708
|
-
interface OrderTransactions {
|
|
4690
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
4691
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4692
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4693
|
+
/** It is to be used in the Business First efforts. */
|
|
4694
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4695
|
+
/** Bookings business flow with no site. */
|
|
4696
|
+
ANYWHERE = "ANYWHERE",
|
|
4697
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
4698
|
+
HEADLESS = "HEADLESS",
|
|
4709
4699
|
/**
|
|
4710
|
-
*
|
|
4711
|
-
*
|
|
4700
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
4701
|
+
* The site will be used for account level CSM feature for enterprise
|
|
4712
4702
|
*/
|
|
4713
|
-
|
|
4703
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
4704
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4705
|
+
RISE = "RISE",
|
|
4714
4706
|
/**
|
|
4715
|
-
*
|
|
4716
|
-
*
|
|
4707
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
4708
|
+
* There's a blank site behind the scene but it's blank).
|
|
4709
|
+
* The Mobile company will be the owner of this namespace.
|
|
4717
4710
|
*/
|
|
4718
|
-
|
|
4711
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
4712
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4713
|
+
NOWNIA = "NOWNIA",
|
|
4719
4714
|
/**
|
|
4720
|
-
*
|
|
4721
|
-
*
|
|
4715
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
4716
|
+
* The Partners company owns this namespace.
|
|
4722
4717
|
*/
|
|
4723
|
-
|
|
4724
|
-
|
|
4725
|
-
|
|
4726
|
-
/**
|
|
4727
|
-
|
|
4728
|
-
/** Gift card payment details. */
|
|
4729
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4730
|
-
/** Membership payment details. */
|
|
4731
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4718
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
4719
|
+
/** Codux Headless Sites */
|
|
4720
|
+
CODUX = "CODUX",
|
|
4721
|
+
/** Bobb - AI Design Creator. */
|
|
4722
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4732
4723
|
/**
|
|
4733
|
-
*
|
|
4734
|
-
*
|
|
4735
|
-
* @readonly
|
|
4724
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
4725
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
4736
4726
|
*/
|
|
4737
|
-
|
|
4738
|
-
/**
|
|
4739
|
-
|
|
4727
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
4728
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4729
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4730
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4731
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4732
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4733
|
+
MIMIR = "MIMIR",
|
|
4734
|
+
/** Wix Twins platform. */
|
|
4735
|
+
TWINS = "TWINS",
|
|
4736
|
+
/** Wix Nano. */
|
|
4737
|
+
NANO = "NANO",
|
|
4738
|
+
/** Base44 headless sites. */
|
|
4739
|
+
BASE44 = "BASE44",
|
|
4740
|
+
/** Wix Channels Sites */
|
|
4741
|
+
CHANNELS = "CHANNELS",
|
|
4742
|
+
/** Nautilus platform. */
|
|
4743
|
+
NAUTILUS = "NAUTILUS",
|
|
4740
4744
|
/**
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4745
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
4746
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
4743
4747
|
*/
|
|
4744
|
-
|
|
4745
|
-
/**
|
|
4746
|
-
|
|
4748
|
+
SYMPHONY = "SYMPHONY",
|
|
4749
|
+
/** Nautilus platform app. */
|
|
4750
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
4747
4751
|
/**
|
|
4748
|
-
*
|
|
4749
|
-
*
|
|
4750
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
4752
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
4753
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
4751
4754
|
*/
|
|
4752
|
-
|
|
4755
|
+
VIBU = "VIBU",
|
|
4753
4756
|
/**
|
|
4754
|
-
*
|
|
4755
|
-
*
|
|
4756
|
-
*
|
|
4757
|
-
*
|
|
4757
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
4758
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
4759
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
4760
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
4758
4761
|
*/
|
|
4759
|
-
|
|
4760
|
-
/** Details about cash rounding applied to this payment, when relevant. */
|
|
4761
|
-
cashRounding?: CashRoundingDetails;
|
|
4762
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
4762
4763
|
/**
|
|
4763
|
-
*
|
|
4764
|
-
*
|
|
4765
|
-
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
4764
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
4765
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
4766
4766
|
*/
|
|
4767
|
-
|
|
4767
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
4768
|
+
}
|
|
4769
|
+
/** @enumType */
|
|
4770
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
|
|
4771
|
+
/** Site transferred to another user. */
|
|
4772
|
+
interface SiteTransferred {
|
|
4768
4773
|
/**
|
|
4769
|
-
*
|
|
4774
|
+
* A previous owner id (user that transfers meta site).
|
|
4770
4775
|
* @format GUID
|
|
4771
4776
|
*/
|
|
4772
|
-
|
|
4777
|
+
oldOwnerId?: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* A new owner id (user that accepts meta site).
|
|
4780
|
+
* @format GUID
|
|
4781
|
+
*/
|
|
4782
|
+
newOwnerId?: string;
|
|
4773
4783
|
}
|
|
4774
|
-
/**
|
|
4775
|
-
interface
|
|
4776
|
-
/**
|
|
4777
|
-
|
|
4778
|
-
/** Gift card payment details. */
|
|
4779
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4780
|
-
/** Membership payment details. */
|
|
4781
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4784
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
4785
|
+
interface SiteDeleted {
|
|
4786
|
+
/** A deletion context. */
|
|
4787
|
+
deleteContext?: DeleteContext;
|
|
4782
4788
|
}
|
|
4783
|
-
|
|
4784
|
-
|
|
4789
|
+
interface DeleteContext {
|
|
4790
|
+
/** When the meta site was deleted. */
|
|
4791
|
+
dateDeleted?: Date | null;
|
|
4792
|
+
/** A status. */
|
|
4793
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
4794
|
+
/**
|
|
4795
|
+
* A reason (flow).
|
|
4796
|
+
* @maxLength 255
|
|
4797
|
+
*/
|
|
4798
|
+
deleteOrigin?: string;
|
|
4799
|
+
/**
|
|
4800
|
+
* A service that deleted it.
|
|
4801
|
+
* @maxLength 255
|
|
4802
|
+
*/
|
|
4803
|
+
initiatorId?: string | null;
|
|
4785
4804
|
}
|
|
4786
|
-
|
|
4787
|
-
|
|
4805
|
+
declare enum DeleteStatus {
|
|
4806
|
+
UNKNOWN = "UNKNOWN",
|
|
4807
|
+
TRASH = "TRASH",
|
|
4808
|
+
DELETED = "DELETED",
|
|
4809
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
4810
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
4788
4811
|
}
|
|
4789
|
-
|
|
4790
|
-
|
|
4791
|
-
|
|
4812
|
+
/** @enumType */
|
|
4813
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
4814
|
+
/** Restoration of the meta site. */
|
|
4815
|
+
interface SiteUndeleted {
|
|
4816
|
+
}
|
|
4817
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
4818
|
+
interface SitePublished {
|
|
4819
|
+
}
|
|
4820
|
+
interface SiteUnpublished {
|
|
4792
4821
|
/**
|
|
4793
|
-
*
|
|
4794
|
-
* @maxLength
|
|
4822
|
+
* A list of URLs previously associated with the meta site.
|
|
4823
|
+
* @maxLength 4000
|
|
4824
|
+
* @maxSize 10000
|
|
4795
4825
|
*/
|
|
4796
|
-
|
|
4826
|
+
urls?: string[];
|
|
4827
|
+
}
|
|
4828
|
+
interface SiteMarkedAsTemplate {
|
|
4829
|
+
}
|
|
4830
|
+
interface SiteMarkedAsWixSite {
|
|
4831
|
+
}
|
|
4832
|
+
/**
|
|
4833
|
+
* Represents a service provisioned a site.
|
|
4834
|
+
*
|
|
4835
|
+
* Note on `origin_instance_id`:
|
|
4836
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
4837
|
+
* This is because of the following scenario:
|
|
4838
|
+
*
|
|
4839
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
4840
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
4841
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
4842
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
4843
|
+
* your site remains consistent with what you initially received and does not include any
|
|
4844
|
+
* changes made to the original template afterward.
|
|
4845
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
4846
|
+
*/
|
|
4847
|
+
interface ServiceProvisioned {
|
|
4797
4848
|
/**
|
|
4798
|
-
*
|
|
4799
|
-
*
|
|
4800
|
-
* @maxLength 100
|
|
4849
|
+
* Either UUID or EmbeddedServiceType.
|
|
4850
|
+
* @maxLength 36
|
|
4801
4851
|
*/
|
|
4802
|
-
|
|
4852
|
+
appDefId?: string;
|
|
4803
4853
|
/**
|
|
4804
|
-
*
|
|
4805
|
-
*
|
|
4806
|
-
* Non-exhaustive list of supported values:
|
|
4807
|
-
* + `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`
|
|
4808
|
-
* @maxLength 150
|
|
4809
|
-
* @deprecated Payment method.
|
|
4810
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4811
|
-
* Non-exhaustive list of supported values:
|
|
4812
|
-
* + `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`
|
|
4813
|
-
* @replacedBy payment_method_name
|
|
4814
|
-
* @targetRemovalDate 2026-07-01
|
|
4854
|
+
* Not only UUID. Something here could be something weird.
|
|
4855
|
+
* @maxLength 36
|
|
4815
4856
|
*/
|
|
4816
|
-
|
|
4857
|
+
instanceId?: string;
|
|
4817
4858
|
/**
|
|
4818
|
-
*
|
|
4819
|
-
* @maxLength
|
|
4859
|
+
* An instance id from which this instance is originated.
|
|
4860
|
+
* @maxLength 36
|
|
4820
4861
|
*/
|
|
4821
|
-
|
|
4822
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
4823
|
-
offlinePayment?: boolean;
|
|
4862
|
+
originInstanceId?: string;
|
|
4824
4863
|
/**
|
|
4825
|
-
*
|
|
4826
|
-
* @
|
|
4827
|
-
* @replacedBy payment.status
|
|
4828
|
-
* @targetRemovalDate 2026-11-01
|
|
4864
|
+
* A version.
|
|
4865
|
+
* @maxLength 500
|
|
4829
4866
|
*/
|
|
4830
|
-
|
|
4831
|
-
/** Whether there is a payment agreement that allows for future charges. */
|
|
4832
|
-
savedPaymentMethod?: boolean;
|
|
4833
|
-
/** Authorization details. */
|
|
4834
|
-
authorizationDetails?: AuthorizationDetails;
|
|
4867
|
+
version?: string | null;
|
|
4835
4868
|
/**
|
|
4836
|
-
*
|
|
4837
|
-
* @
|
|
4869
|
+
* The origin meta site id
|
|
4870
|
+
* @format GUID
|
|
4838
4871
|
*/
|
|
4839
|
-
|
|
4840
|
-
|
|
4841
|
-
|
|
4872
|
+
originMetaSiteId?: string | null;
|
|
4873
|
+
}
|
|
4874
|
+
interface ServiceRemoved {
|
|
4842
4875
|
/**
|
|
4843
|
-
*
|
|
4844
|
-
*
|
|
4845
|
-
* + `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`
|
|
4876
|
+
* Either UUID or EmbeddedServiceType.
|
|
4877
|
+
* @maxLength 36
|
|
4846
4878
|
*/
|
|
4847
|
-
|
|
4848
|
-
}
|
|
4849
|
-
/** @oneof */
|
|
4850
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
4851
|
-
/** Credit card details. */
|
|
4852
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4853
|
-
}
|
|
4854
|
-
declare enum TransactionStatus {
|
|
4855
|
-
UNDEFINED = "UNDEFINED",
|
|
4856
|
-
APPROVED = "APPROVED",
|
|
4857
|
-
PENDING = "PENDING",
|
|
4858
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4859
|
-
CANCELED = "CANCELED",
|
|
4860
|
-
DECLINED = "DECLINED",
|
|
4861
|
-
REFUNDED = "REFUNDED",
|
|
4862
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4863
|
-
AUTHORIZED = "AUTHORIZED",
|
|
4864
|
-
VOIDED = "VOIDED"
|
|
4865
|
-
}
|
|
4866
|
-
/** @enumType */
|
|
4867
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4868
|
-
interface CreditCardPaymentMethodDetails {
|
|
4879
|
+
appDefId?: string;
|
|
4869
4880
|
/**
|
|
4870
|
-
*
|
|
4871
|
-
* @maxLength
|
|
4881
|
+
* Not only UUID. Something here could be something weird.
|
|
4882
|
+
* @maxLength 36
|
|
4872
4883
|
*/
|
|
4873
|
-
|
|
4884
|
+
instanceId?: string;
|
|
4874
4885
|
/**
|
|
4875
|
-
*
|
|
4876
|
-
* @maxLength
|
|
4886
|
+
* A version.
|
|
4887
|
+
* @maxLength 500
|
|
4877
4888
|
*/
|
|
4878
|
-
|
|
4889
|
+
version?: string | null;
|
|
4879
4890
|
}
|
|
4880
|
-
|
|
4891
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
4892
|
+
interface SiteRenamed {
|
|
4881
4893
|
/**
|
|
4882
|
-
*
|
|
4883
|
-
* @
|
|
4894
|
+
* A new meta site name (URL slug).
|
|
4895
|
+
* @maxLength 20
|
|
4884
4896
|
*/
|
|
4885
|
-
|
|
4886
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4887
|
-
authorizedDate?: Date | null;
|
|
4897
|
+
newSiteName?: string;
|
|
4888
4898
|
/**
|
|
4889
|
-
*
|
|
4890
|
-
*
|
|
4891
|
-
* @maxSize 1
|
|
4899
|
+
* A previous meta site name (URL slug).
|
|
4900
|
+
* @maxLength 255
|
|
4892
4901
|
*/
|
|
4893
|
-
|
|
4894
|
-
/** Void associated with payment */
|
|
4895
|
-
void?: AuthorizationVoid;
|
|
4896
|
-
/** Scheduled action for this transaction */
|
|
4897
|
-
scheduledAction?: V1ScheduledAction;
|
|
4902
|
+
oldSiteName?: string;
|
|
4898
4903
|
}
|
|
4899
|
-
|
|
4900
|
-
|
|
4901
|
-
|
|
4902
|
-
|
|
4903
|
-
|
|
4904
|
-
|
|
4905
|
-
|
|
4906
|
-
|
|
4907
|
-
|
|
4904
|
+
/**
|
|
4905
|
+
* Hard deletion of the meta site.
|
|
4906
|
+
*
|
|
4907
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
4908
|
+
*/
|
|
4909
|
+
interface SiteHardDeleted {
|
|
4910
|
+
/** A deletion context. */
|
|
4911
|
+
deleteContext?: DeleteContext;
|
|
4912
|
+
}
|
|
4913
|
+
interface NamespaceChanged {
|
|
4914
|
+
/** A previous namespace. */
|
|
4915
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
4916
|
+
/** A new namespace. */
|
|
4917
|
+
newNamespace?: NamespaceWithLiterals;
|
|
4918
|
+
}
|
|
4919
|
+
/** Assigned Studio editor */
|
|
4920
|
+
interface StudioAssigned {
|
|
4921
|
+
}
|
|
4922
|
+
/** Unassigned Studio editor */
|
|
4923
|
+
interface StudioUnassigned {
|
|
4924
|
+
}
|
|
4925
|
+
/**
|
|
4926
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4927
|
+
*
|
|
4928
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4929
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4930
|
+
*
|
|
4931
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4932
|
+
*/
|
|
4933
|
+
interface SiteUrlChanged {
|
|
4934
|
+
}
|
|
4935
|
+
/**
|
|
4936
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4937
|
+
* Consumed by other teams to remove relevant data.
|
|
4938
|
+
*/
|
|
4939
|
+
interface SitePurgedExternally {
|
|
4908
4940
|
/**
|
|
4909
|
-
*
|
|
4910
|
-
* @
|
|
4941
|
+
* @maxLength 2048
|
|
4942
|
+
* @maxSize 100
|
|
4943
|
+
* @deprecated
|
|
4944
|
+
* @targetRemovalDate 2025-04-15
|
|
4911
4945
|
*/
|
|
4912
|
-
|
|
4913
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4914
|
-
createdDate?: Date | null;
|
|
4915
|
-
/** In case of status is FAILED may contain failure details */
|
|
4916
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4946
|
+
appDefId?: string[];
|
|
4917
4947
|
}
|
|
4918
|
-
|
|
4919
|
-
|
|
4920
|
-
PENDING = "PENDING",
|
|
4921
|
-
/** Capture operation succeeded. */
|
|
4922
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4923
|
-
/** Capture operation failed. */
|
|
4924
|
-
FAILED = "FAILED"
|
|
4948
|
+
/** Assigned Odeditor */
|
|
4949
|
+
interface OdeditorAssigned {
|
|
4925
4950
|
}
|
|
4926
|
-
/**
|
|
4927
|
-
|
|
4928
|
-
interface AuthorizationActionFailureDetails {
|
|
4929
|
-
/** @maxLength 100 */
|
|
4930
|
-
failureCode?: string;
|
|
4951
|
+
/** Unassigned Odeditor */
|
|
4952
|
+
interface OdeditorUnassigned {
|
|
4931
4953
|
}
|
|
4932
|
-
|
|
4933
|
-
|
|
4934
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
4935
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4936
|
-
voidedDate?: Date | null;
|
|
4937
|
-
/** In case of status is FAILED may contain failure details */
|
|
4938
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4939
|
-
/** Reason of void action */
|
|
4940
|
-
reason?: ReasonWithLiterals;
|
|
4954
|
+
/** Assigned Picasso editor */
|
|
4955
|
+
interface PicassoAssigned {
|
|
4941
4956
|
}
|
|
4942
|
-
|
|
4943
|
-
|
|
4944
|
-
|
|
4945
|
-
|
|
4946
|
-
|
|
4947
|
-
|
|
4948
|
-
|
|
4957
|
+
/** Unassigned Picasso */
|
|
4958
|
+
interface PicassoUnassigned {
|
|
4959
|
+
}
|
|
4960
|
+
/** Assigned Wixel */
|
|
4961
|
+
interface WixelAssigned {
|
|
4962
|
+
}
|
|
4963
|
+
/** Unassigned Wixel */
|
|
4964
|
+
interface WixelUnassigned {
|
|
4965
|
+
}
|
|
4966
|
+
/** Assigned StudioTwo */
|
|
4967
|
+
interface StudioTwoAssigned {
|
|
4968
|
+
}
|
|
4969
|
+
/** Unassigned StudioTwo */
|
|
4970
|
+
interface StudioTwoUnassigned {
|
|
4971
|
+
}
|
|
4972
|
+
/** Media from user domain is enabled. */
|
|
4973
|
+
interface UserDomainMediaEnabled {
|
|
4974
|
+
}
|
|
4975
|
+
/** Media from user domain is disabled. */
|
|
4976
|
+
interface UserDomainMediaDisabled {
|
|
4977
|
+
}
|
|
4978
|
+
/** Assigned Editorless */
|
|
4979
|
+
interface EditorlessAssigned {
|
|
4980
|
+
}
|
|
4981
|
+
/** Unassigned Editorless */
|
|
4982
|
+
interface EditorlessUnassigned {
|
|
4983
|
+
}
|
|
4984
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
4985
|
+
}
|
|
4986
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
4987
|
+
hasCustomConfigurations?: boolean;
|
|
4988
|
+
}
|
|
4989
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
4990
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
4991
|
+
sendCustomEmailConfigs?: boolean;
|
|
4992
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
4993
|
+
origin?: OriginWithLiterals;
|
|
4994
|
+
}
|
|
4995
|
+
declare enum Origin {
|
|
4996
|
+
OPT_IN = "OPT_IN",
|
|
4997
|
+
MIGRATION = "MIGRATION"
|
|
4949
4998
|
}
|
|
4950
4999
|
/** @enumType */
|
|
4951
|
-
type
|
|
4952
|
-
|
|
4953
|
-
|
|
4954
|
-
/** Authorization was voided by user. */
|
|
4955
|
-
MANUAL = "MANUAL",
|
|
4956
|
-
/** Authorization passed execution date. */
|
|
4957
|
-
SCHEDULED = "SCHEDULED"
|
|
5000
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
5001
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
5002
|
+
success?: boolean;
|
|
4958
5003
|
}
|
|
4959
|
-
|
|
4960
|
-
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
4961
|
-
interface V1ScheduledAction {
|
|
4962
|
-
/** Type of the action. */
|
|
4963
|
-
actionType?: ActionTypeWithLiterals;
|
|
4964
|
-
/** The date and time of the action. */
|
|
4965
|
-
executionDate?: Date | null;
|
|
5004
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
4966
5005
|
}
|
|
4967
|
-
|
|
4968
|
-
|
|
4969
|
-
CAPTURE = "CAPTURE"
|
|
5006
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
5007
|
+
inPopulation?: boolean;
|
|
4970
5008
|
}
|
|
4971
|
-
|
|
4972
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
4973
|
-
interface Chargeback {
|
|
5009
|
+
interface PreparePaymentCollectionRequest {
|
|
4974
5010
|
/**
|
|
4975
|
-
*
|
|
4976
|
-
* @
|
|
4977
|
-
* @
|
|
4978
|
-
* @immutable
|
|
5011
|
+
* Ecom order ID.
|
|
5012
|
+
* @minLength 1
|
|
5013
|
+
* @maxLength 100
|
|
4979
5014
|
*/
|
|
4980
|
-
|
|
5015
|
+
ecomOrderId: string;
|
|
5016
|
+
/** Amount to collect */
|
|
5017
|
+
amount: Price;
|
|
4981
5018
|
/**
|
|
4982
|
-
*
|
|
4983
|
-
*
|
|
4984
|
-
*
|
|
5019
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
5020
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
5021
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4985
5022
|
*/
|
|
4986
|
-
|
|
5023
|
+
paymentGatewayOrderId?: string | null;
|
|
4987
5024
|
/**
|
|
4988
|
-
*
|
|
4989
|
-
*
|
|
5025
|
+
* Whether to delay capture of the payment.
|
|
5026
|
+
* Default: false
|
|
5027
|
+
* @deprecated Whether to delay capture of the payment.
|
|
5028
|
+
* Default: false
|
|
5029
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
5030
|
+
* @targetRemovalDate 2024-09-30
|
|
4990
5031
|
*/
|
|
4991
|
-
|
|
5032
|
+
delayedCapture?: boolean;
|
|
5033
|
+
/** Delayed capture payment settings */
|
|
5034
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
5035
|
+
}
|
|
5036
|
+
interface RedirectUrls {
|
|
4992
5037
|
/**
|
|
4993
|
-
*
|
|
4994
|
-
* @
|
|
4995
|
-
* @immutable
|
|
5038
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
5039
|
+
* @format WEB_URL
|
|
4996
5040
|
*/
|
|
4997
|
-
|
|
5041
|
+
successUrl?: string | null;
|
|
4998
5042
|
/**
|
|
4999
|
-
*
|
|
5000
|
-
* @
|
|
5043
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
5044
|
+
* @format WEB_URL
|
|
5001
5045
|
*/
|
|
5002
|
-
|
|
5046
|
+
cancelUrl?: string | null;
|
|
5003
5047
|
/**
|
|
5004
|
-
*
|
|
5005
|
-
*
|
|
5006
|
-
* Default: `"APPROVED"`.
|
|
5048
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
5049
|
+
* @format WEB_URL
|
|
5007
5050
|
*/
|
|
5008
|
-
|
|
5051
|
+
errorUrl?: string | null;
|
|
5009
5052
|
/**
|
|
5010
|
-
*
|
|
5011
|
-
* @format
|
|
5012
|
-
* @readonly
|
|
5013
|
-
* @immutable
|
|
5053
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
5054
|
+
* @format WEB_URL
|
|
5014
5055
|
*/
|
|
5015
|
-
|
|
5056
|
+
pendingUrl?: string | null;
|
|
5016
5057
|
}
|
|
5017
|
-
|
|
5018
|
-
/**
|
|
5019
|
-
|
|
5020
|
-
/**
|
|
5021
|
-
|
|
5058
|
+
interface DelayedCaptureSettings {
|
|
5059
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
5060
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
5061
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
5062
|
+
delayDuration?: Duration;
|
|
5063
|
+
}
|
|
5064
|
+
declare enum ScheduledAction {
|
|
5065
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
5066
|
+
VOID = "VOID",
|
|
5067
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
5068
|
+
CAPTURE = "CAPTURE"
|
|
5022
5069
|
}
|
|
5023
5070
|
/** @enumType */
|
|
5024
|
-
type
|
|
5025
|
-
interface
|
|
5026
|
-
/**
|
|
5027
|
-
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
5028
|
-
* @maxLength 150
|
|
5029
|
-
*/
|
|
5030
|
-
buyerLanguageName?: string | null;
|
|
5031
|
-
/**
|
|
5032
|
-
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
5033
|
-
*
|
|
5034
|
-
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
5035
|
-
* @maxLength 150
|
|
5036
|
-
*/
|
|
5037
|
-
siteLanguageName?: string | null;
|
|
5071
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
5072
|
+
interface Duration {
|
|
5038
5073
|
/**
|
|
5039
|
-
*
|
|
5040
|
-
*
|
|
5041
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5074
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
5075
|
+
* @min 1
|
|
5042
5076
|
*/
|
|
5043
|
-
|
|
5077
|
+
count?: number;
|
|
5078
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
5079
|
+
unit?: DurationUnitWithLiterals;
|
|
5044
5080
|
}
|
|
5045
|
-
|
|
5046
|
-
|
|
5047
|
-
|
|
5048
|
-
|
|
5049
|
-
*/
|
|
5050
|
-
giftCardPaymentId?: string;
|
|
5051
|
-
/**
|
|
5052
|
-
* ID of the app that created the gift card.
|
|
5053
|
-
* @format GUID
|
|
5054
|
-
*/
|
|
5055
|
-
appId?: string;
|
|
5056
|
-
/**
|
|
5057
|
-
* Whether the gift card is voided.
|
|
5058
|
-
* @readonly
|
|
5059
|
-
* @deprecated Whether the gift card is voided.
|
|
5060
|
-
* @replacedBy payment.status
|
|
5061
|
-
* @targetRemovalDate 2026-11-01
|
|
5062
|
-
*/
|
|
5063
|
-
voided?: boolean;
|
|
5064
|
-
/**
|
|
5065
|
-
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
5066
|
-
* @maxLength 30
|
|
5067
|
-
* @immutable
|
|
5068
|
-
*/
|
|
5069
|
-
obfuscatedCode?: string | null;
|
|
5081
|
+
declare enum DurationUnit {
|
|
5082
|
+
MINUTES = "MINUTES",
|
|
5083
|
+
HOURS = "HOURS",
|
|
5084
|
+
DAYS = "DAYS"
|
|
5070
5085
|
}
|
|
5071
|
-
|
|
5072
|
-
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5076
|
-
|
|
5086
|
+
/** @enumType */
|
|
5087
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
5088
|
+
interface PreparePaymentCollectionResponse {
|
|
5089
|
+
/** Payment gateway order id which is associated with given payment */
|
|
5090
|
+
paymentGatewayOrderId?: string;
|
|
5091
|
+
}
|
|
5092
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
5077
5093
|
/**
|
|
5078
|
-
*
|
|
5094
|
+
* Ecom order ID.
|
|
5079
5095
|
* @minLength 1
|
|
5080
5096
|
* @maxLength 100
|
|
5081
5097
|
*/
|
|
5082
|
-
|
|
5083
|
-
|
|
5084
|
-
|
|
5085
|
-
|
|
5086
|
-
|
|
5087
|
-
|
|
5088
|
-
|
|
5089
|
-
|
|
5090
|
-
|
|
5091
|
-
|
|
5098
|
+
ecomOrderId: string;
|
|
5099
|
+
}
|
|
5100
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
5101
|
+
/** Payment collectability status */
|
|
5102
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
5103
|
+
/** Collectable order amount */
|
|
5104
|
+
amount?: Price;
|
|
5105
|
+
}
|
|
5106
|
+
declare enum PaymentCollectabilityStatus {
|
|
5107
|
+
UNKNOWN = "UNKNOWN",
|
|
5108
|
+
COLLECTABLE = "COLLECTABLE",
|
|
5109
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
5110
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
5111
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
5112
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
5113
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
5114
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
5115
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
5116
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
5117
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
5118
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
5119
|
+
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
5120
|
+
}
|
|
5121
|
+
/** @enumType */
|
|
5122
|
+
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
|
|
5123
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
5092
5124
|
/**
|
|
5093
|
-
*
|
|
5125
|
+
* Order ID.
|
|
5094
5126
|
* @minLength 1
|
|
5095
5127
|
* @maxLength 100
|
|
5096
5128
|
*/
|
|
5097
|
-
|
|
5129
|
+
orderId: string;
|
|
5130
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
5131
|
+
amount: Price;
|
|
5132
|
+
}
|
|
5133
|
+
/**
|
|
5134
|
+
* User-defined payment method name.
|
|
5135
|
+
* Allows specifying either a predefined type or a custom name.
|
|
5136
|
+
*/
|
|
5137
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
5138
|
+
/** Predefined payment method. */
|
|
5139
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5098
5140
|
/**
|
|
5099
|
-
*
|
|
5100
|
-
*
|
|
5101
|
-
*
|
|
5102
|
-
* @
|
|
5103
|
-
* @
|
|
5141
|
+
* Custom payment method name provided by user.
|
|
5142
|
+
*
|
|
5143
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5144
|
+
* @minLength 1
|
|
5145
|
+
* @maxLength 150
|
|
5104
5146
|
*/
|
|
5105
|
-
|
|
5147
|
+
custom?: string | null;
|
|
5148
|
+
}
|
|
5149
|
+
/** @oneof */
|
|
5150
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
5151
|
+
/** Predefined payment method. */
|
|
5152
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5106
5153
|
/**
|
|
5107
|
-
*
|
|
5108
|
-
*
|
|
5154
|
+
* Custom payment method name provided by user.
|
|
5155
|
+
*
|
|
5156
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5157
|
+
* @minLength 1
|
|
5158
|
+
* @maxLength 150
|
|
5109
5159
|
*/
|
|
5110
|
-
|
|
5111
|
-
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5112
|
-
futureMembership?: FutureMembershipDetails;
|
|
5160
|
+
custom?: string | null;
|
|
5113
5161
|
}
|
|
5114
|
-
|
|
5115
|
-
|
|
5116
|
-
|
|
5117
|
-
|
|
5118
|
-
|
|
5119
|
-
|
|
5120
|
-
|
|
5121
|
-
|
|
5122
|
-
VOIDED = "VOIDED"
|
|
5162
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
5163
|
+
declare enum PredefinedPaymentMethod {
|
|
5164
|
+
/** Cash payment. */
|
|
5165
|
+
CASH = "CASH",
|
|
5166
|
+
/** Bank transfer. */
|
|
5167
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
5168
|
+
/** Payment by check. */
|
|
5169
|
+
CHECK = "CHECK"
|
|
5123
5170
|
}
|
|
5124
5171
|
/** @enumType */
|
|
5125
|
-
type
|
|
5126
|
-
interface
|
|
5127
|
-
/**
|
|
5128
|
-
* ID of the plan line item in the order from which the membership will be created.
|
|
5129
|
-
* @format GUID
|
|
5130
|
-
*/
|
|
5131
|
-
lineItemId?: string;
|
|
5132
|
-
/**
|
|
5133
|
-
* ID of the benefit the future membership will grant.
|
|
5134
|
-
* @maxLength 200
|
|
5135
|
-
*/
|
|
5136
|
-
benefitId?: string;
|
|
5172
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
5173
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
5137
5174
|
}
|
|
5138
|
-
interface
|
|
5175
|
+
interface MarkOrderAsPaidRequest {
|
|
5139
5176
|
/**
|
|
5140
|
-
*
|
|
5141
|
-
* @
|
|
5177
|
+
* Ecom order ID.
|
|
5178
|
+
* @minLength 1
|
|
5179
|
+
* @maxLength 100
|
|
5142
5180
|
*/
|
|
5143
|
-
|
|
5181
|
+
ecomOrderId: string;
|
|
5182
|
+
}
|
|
5183
|
+
interface MarkOrderAsPaidResponse {
|
|
5184
|
+
/** Updated order. */
|
|
5185
|
+
order?: Order;
|
|
5186
|
+
}
|
|
5187
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
5144
5188
|
/**
|
|
5145
|
-
*
|
|
5189
|
+
* IDs of orders to mark as paid.
|
|
5190
|
+
* @minSize 1
|
|
5191
|
+
* @maxSize 100
|
|
5146
5192
|
* @minLength 1
|
|
5147
|
-
* @maxLength
|
|
5193
|
+
* @maxLength 100
|
|
5148
5194
|
*/
|
|
5149
|
-
|
|
5195
|
+
ecomOrderIds: string[];
|
|
5150
5196
|
}
|
|
5151
|
-
interface
|
|
5197
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
5152
5198
|
/**
|
|
5153
|
-
*
|
|
5154
|
-
*
|
|
5199
|
+
* Items updated by the bulk action.
|
|
5200
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
5155
5201
|
*/
|
|
5156
|
-
|
|
5202
|
+
results?: BulkOrderResult[];
|
|
5203
|
+
/** Bulk action metadata. */
|
|
5204
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
5205
|
+
}
|
|
5206
|
+
interface BulkOrderResult {
|
|
5207
|
+
/** Item metadata. */
|
|
5208
|
+
itemMetadata?: ItemMetadata;
|
|
5157
5209
|
/**
|
|
5158
|
-
*
|
|
5159
|
-
*
|
|
5210
|
+
* Updated order.
|
|
5211
|
+
*
|
|
5212
|
+
* Returned when `returnFullEntity = true`.
|
|
5160
5213
|
*/
|
|
5161
|
-
|
|
5214
|
+
item?: Order;
|
|
5215
|
+
}
|
|
5216
|
+
interface ItemMetadata {
|
|
5217
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5218
|
+
id?: string | null;
|
|
5219
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5220
|
+
originalIndex?: number;
|
|
5221
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5222
|
+
success?: boolean;
|
|
5223
|
+
/** Details about the error in case of failure. */
|
|
5224
|
+
error?: ApplicationError;
|
|
5225
|
+
}
|
|
5226
|
+
interface ApplicationError {
|
|
5227
|
+
/** Error code. */
|
|
5228
|
+
code?: string;
|
|
5229
|
+
/** Description of the error. */
|
|
5230
|
+
description?: string;
|
|
5231
|
+
/** Data related to the error. */
|
|
5232
|
+
data?: Record<string, any> | null;
|
|
5233
|
+
}
|
|
5234
|
+
interface BulkActionMetadata {
|
|
5235
|
+
/** Number of items that were successfully processed. */
|
|
5236
|
+
totalSuccesses?: number;
|
|
5237
|
+
/** Number of items that couldn't be processed. */
|
|
5238
|
+
totalFailures?: number;
|
|
5239
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5240
|
+
undetailedFailures?: number;
|
|
5241
|
+
}
|
|
5242
|
+
interface GetRefundabilityStatusRequest {
|
|
5162
5243
|
/**
|
|
5163
|
-
*
|
|
5244
|
+
* Order ID.
|
|
5164
5245
|
* @minLength 1
|
|
5165
|
-
* @maxLength
|
|
5246
|
+
* @maxLength 100
|
|
5166
5247
|
*/
|
|
5167
|
-
|
|
5248
|
+
ecomOrderId: string;
|
|
5168
5249
|
}
|
|
5169
|
-
interface
|
|
5250
|
+
interface GetRefundabilityStatusResponse {
|
|
5170
5251
|
/**
|
|
5171
|
-
*
|
|
5172
|
-
*
|
|
5173
|
-
* to prevent false overpayment or underpayment due to rounding.
|
|
5252
|
+
* Refundability details.
|
|
5253
|
+
* @maxSize 300
|
|
5174
5254
|
*/
|
|
5175
|
-
|
|
5255
|
+
refundabilities?: Refundability[];
|
|
5176
5256
|
/**
|
|
5177
|
-
*
|
|
5178
|
-
*
|
|
5179
|
-
* @readonly
|
|
5257
|
+
* Whether the order supports refunding per item.
|
|
5258
|
+
* @deprecated
|
|
5180
5259
|
*/
|
|
5181
|
-
|
|
5260
|
+
refundablePerItem?: boolean;
|
|
5182
5261
|
}
|
|
5183
|
-
|
|
5184
|
-
/**
|
|
5185
|
-
|
|
5186
|
-
/**
|
|
5187
|
-
|
|
5188
|
-
/** Payment
|
|
5189
|
-
|
|
5190
|
-
/** Payment
|
|
5191
|
-
|
|
5192
|
-
/**
|
|
5193
|
-
|
|
5194
|
-
/** Payment was fully refunded. */
|
|
5195
|
-
REFUNDED = "REFUNDED",
|
|
5196
|
-
/** Part of the payment amount was refunded. */
|
|
5197
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5198
|
-
/** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
|
|
5199
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5200
|
-
/**
|
|
5201
|
-
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
5202
|
-
*
|
|
5203
|
-
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
5204
|
-
*/
|
|
5205
|
-
VOIDED = "VOIDED"
|
|
5262
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5263
|
+
/** Reason why payment is not refundable. */
|
|
5264
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5265
|
+
/** Reason why payment is only refundable manually. */
|
|
5266
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5267
|
+
/** Payment ID. */
|
|
5268
|
+
paymentId?: string;
|
|
5269
|
+
/** Payment refundability status. */
|
|
5270
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
5271
|
+
/** Link to payment provider dashboard. */
|
|
5272
|
+
providerLink?: string | null;
|
|
5206
5273
|
}
|
|
5207
|
-
/** @
|
|
5208
|
-
|
|
5209
|
-
|
|
5210
|
-
|
|
5274
|
+
/** @oneof */
|
|
5275
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5276
|
+
/** Reason why payment is not refundable. */
|
|
5277
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5278
|
+
/** Reason why payment is only refundable manually. */
|
|
5279
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5211
5280
|
}
|
|
5212
|
-
declare enum
|
|
5213
|
-
|
|
5214
|
-
|
|
5215
|
-
|
|
5216
|
-
EXPIRED = "EXPIRED"
|
|
5281
|
+
declare enum RefundableStatus {
|
|
5282
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
5283
|
+
MANUAL = "MANUAL",
|
|
5284
|
+
REFUNDABLE = "REFUNDABLE"
|
|
5217
5285
|
}
|
|
5218
5286
|
/** @enumType */
|
|
5219
|
-
type
|
|
5220
|
-
|
|
5221
|
-
|
|
5222
|
-
|
|
5223
|
-
|
|
5224
|
-
|
|
5225
|
-
|
|
5226
|
-
|
|
5227
|
-
|
|
5228
|
-
|
|
5229
|
-
|
|
5230
|
-
|
|
5231
|
-
|
|
5287
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
5288
|
+
declare enum NonRefundableReason {
|
|
5289
|
+
NONE = "NONE",
|
|
5290
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
5291
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
5292
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
5293
|
+
NOT_PAID = "NOT_PAID",
|
|
5294
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5295
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
5296
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5297
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
5298
|
+
FORBIDDEN = "FORBIDDEN",
|
|
5299
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5300
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5301
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5232
5302
|
}
|
|
5233
5303
|
/** @enumType */
|
|
5234
|
-
type
|
|
5235
|
-
|
|
5236
|
-
|
|
5237
|
-
|
|
5238
|
-
|
|
5239
|
-
|
|
5240
|
-
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
5241
|
-
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
5242
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
5304
|
+
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';
|
|
5305
|
+
declare enum ManuallyRefundableReason {
|
|
5306
|
+
EXPIRED = "EXPIRED",
|
|
5307
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
5308
|
+
OFFLINE = "OFFLINE",
|
|
5309
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
5243
5310
|
}
|
|
5244
5311
|
/** @enumType */
|
|
5245
|
-
type
|
|
5246
|
-
interface
|
|
5247
|
-
|
|
5248
|
-
|
|
5249
|
-
|
|
5312
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
5313
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
5314
|
+
/**
|
|
5315
|
+
* Ecom order ID.
|
|
5316
|
+
* @minLength 1
|
|
5317
|
+
* @maxLength 100
|
|
5318
|
+
*/
|
|
5319
|
+
ecomOrderId: string;
|
|
5320
|
+
/** Information about the user who initiated the payment. */
|
|
5321
|
+
chargedBy?: ChargedBy;
|
|
5250
5322
|
}
|
|
5251
|
-
interface
|
|
5323
|
+
interface ChargedBy {
|
|
5252
5324
|
/**
|
|
5253
|
-
*
|
|
5325
|
+
* ID - id of the user who initiated the payment
|
|
5254
5326
|
* @format GUID
|
|
5255
|
-
* @readonly
|
|
5256
5327
|
*/
|
|
5257
5328
|
id?: string;
|
|
5258
5329
|
/**
|
|
5259
|
-
*
|
|
5260
|
-
* @
|
|
5330
|
+
* Full name - name of the user who initiated the payment
|
|
5331
|
+
* @minLength 1
|
|
5332
|
+
* @maxLength 200
|
|
5261
5333
|
*/
|
|
5262
|
-
|
|
5263
|
-
|
|
5264
|
-
|
|
5334
|
+
fullName?: string | null;
|
|
5335
|
+
}
|
|
5336
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
5337
|
+
/** ID of the order created in the payment gateway */
|
|
5338
|
+
paymentGatewayOrderId?: string;
|
|
5339
|
+
}
|
|
5340
|
+
interface ChargeMembershipsRequest {
|
|
5265
5341
|
/**
|
|
5266
|
-
*
|
|
5267
|
-
* @
|
|
5268
|
-
* @
|
|
5342
|
+
* Order ID.
|
|
5343
|
+
* @minLength 1
|
|
5344
|
+
* @maxLength 100
|
|
5345
|
+
*/
|
|
5346
|
+
ecomOrderId: string;
|
|
5347
|
+
/**
|
|
5348
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
5349
|
+
* but a user which is using the membership on behalf of the a member
|
|
5350
|
+
* @format GUID
|
|
5351
|
+
*/
|
|
5352
|
+
memberId: string;
|
|
5353
|
+
/**
|
|
5354
|
+
* List of items to be paid by memberships
|
|
5355
|
+
* @minSize 1
|
|
5356
|
+
* @maxSize 300
|
|
5269
5357
|
*/
|
|
5270
|
-
|
|
5358
|
+
membershipCharges?: MembershipChargeItem[];
|
|
5359
|
+
}
|
|
5360
|
+
interface MembershipChargeItem {
|
|
5271
5361
|
/**
|
|
5272
|
-
*
|
|
5273
|
-
* @
|
|
5362
|
+
* The id of used membership
|
|
5363
|
+
* @minLength 1
|
|
5364
|
+
* @maxLength 100
|
|
5274
5365
|
*/
|
|
5275
|
-
|
|
5366
|
+
membershipId?: string;
|
|
5276
5367
|
/**
|
|
5277
|
-
* ID of the
|
|
5368
|
+
* ID of the application providing this payment option
|
|
5278
5369
|
* @format GUID
|
|
5279
|
-
* @readonly
|
|
5280
|
-
* @immutable
|
|
5281
5370
|
*/
|
|
5282
|
-
|
|
5283
|
-
|
|
5284
|
-
|
|
5371
|
+
appId?: string;
|
|
5372
|
+
/** The name of used membership */
|
|
5373
|
+
membershipName?: MembershipName;
|
|
5374
|
+
/** Additional data about this membership */
|
|
5375
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
5376
|
+
/** Catalog and item reference info. */
|
|
5377
|
+
catalogReference?: CatalogReference;
|
|
5378
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5379
|
+
serviceProperties?: ServiceProperties;
|
|
5285
5380
|
/**
|
|
5286
|
-
*
|
|
5287
|
-
*
|
|
5288
|
-
*
|
|
5381
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
5382
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
5383
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
5384
|
+
* @minLength 1
|
|
5385
|
+
* @maxLength 36
|
|
5289
5386
|
*/
|
|
5290
|
-
|
|
5387
|
+
rootCatalogItemId?: string | null;
|
|
5291
5388
|
/**
|
|
5292
|
-
*
|
|
5293
|
-
* @
|
|
5389
|
+
* line item id of Checkout/Order line item
|
|
5390
|
+
* @minLength 1
|
|
5391
|
+
* @maxLength 100
|
|
5294
5392
|
*/
|
|
5295
|
-
|
|
5296
|
-
|
|
5297
|
-
|
|
5298
|
-
/** Optional details of current refund status. */
|
|
5299
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
5393
|
+
lineItemId?: string;
|
|
5394
|
+
}
|
|
5395
|
+
interface MembershipName {
|
|
5300
5396
|
/**
|
|
5301
|
-
*
|
|
5302
|
-
*
|
|
5303
|
-
* @format GUID
|
|
5397
|
+
* Membership name in the site's original language.
|
|
5398
|
+
* @maxLength 100
|
|
5304
5399
|
*/
|
|
5305
|
-
|
|
5306
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5307
|
-
providerRefundId?: string | null;
|
|
5400
|
+
original?: string;
|
|
5308
5401
|
/**
|
|
5309
|
-
*
|
|
5310
|
-
*
|
|
5402
|
+
* Membership name translated into the buyer's language.
|
|
5403
|
+
*
|
|
5404
|
+
* Default: The value of `original`
|
|
5405
|
+
* @maxLength 100
|
|
5311
5406
|
*/
|
|
5312
|
-
|
|
5407
|
+
translated?: string | null;
|
|
5313
5408
|
}
|
|
5314
|
-
|
|
5315
|
-
declare enum RefundStatus {
|
|
5316
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5317
|
-
PENDING = "PENDING",
|
|
5318
|
-
/** Refund transaction succeeded. */
|
|
5319
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5320
|
-
/** Refund transaction failed. */
|
|
5321
|
-
FAILED = "FAILED",
|
|
5322
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
5323
|
-
SCHEDULED = "SCHEDULED",
|
|
5324
|
-
/** Refund was initiated on payment provider side. */
|
|
5325
|
-
STARTED = "STARTED"
|
|
5409
|
+
interface ChargeMembershipsResponse {
|
|
5326
5410
|
}
|
|
5327
|
-
|
|
5328
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5329
|
-
interface RefundStatusInfo {
|
|
5411
|
+
interface TriggerRefundRequest {
|
|
5330
5412
|
/**
|
|
5331
|
-
*
|
|
5332
|
-
*
|
|
5333
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5413
|
+
* The order this refund related to
|
|
5334
5414
|
* @minLength 1
|
|
5335
|
-
* @maxLength
|
|
5415
|
+
* @maxLength 100
|
|
5336
5416
|
*/
|
|
5337
|
-
|
|
5417
|
+
ecomOrderId: string;
|
|
5338
5418
|
/**
|
|
5339
|
-
*
|
|
5340
|
-
* @
|
|
5341
|
-
* @
|
|
5419
|
+
* Refund operations information
|
|
5420
|
+
* @minSize 1
|
|
5421
|
+
* @maxSize 1
|
|
5342
5422
|
*/
|
|
5343
|
-
|
|
5344
|
-
|
|
5345
|
-
|
|
5346
|
-
/**
|
|
5347
|
-
|
|
5348
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5349
|
-
pendingRefund?: Price;
|
|
5350
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5351
|
-
refunded?: Price;
|
|
5352
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5353
|
-
failedRefundAmount?: Price;
|
|
5354
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5355
|
-
pending?: boolean;
|
|
5356
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5357
|
-
breakdown?: RefundItemsBreakdown;
|
|
5423
|
+
payments: PaymentRefund[];
|
|
5424
|
+
/** Business model of a refund */
|
|
5425
|
+
details?: RefundDetails;
|
|
5426
|
+
/** Side effect details related to refund */
|
|
5427
|
+
sideEffects?: RefundSideEffects;
|
|
5358
5428
|
}
|
|
5359
|
-
interface
|
|
5429
|
+
interface PaymentRefund {
|
|
5360
5430
|
/**
|
|
5361
|
-
*
|
|
5362
|
-
* @
|
|
5431
|
+
* Specific payment within the order to refund
|
|
5432
|
+
* @format GUID
|
|
5363
5433
|
*/
|
|
5364
|
-
|
|
5365
|
-
|
|
5366
|
-
|
|
5434
|
+
paymentId?: string;
|
|
5435
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5436
|
+
amount?: Price;
|
|
5367
5437
|
/**
|
|
5368
|
-
*
|
|
5369
|
-
*
|
|
5438
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5439
|
+
* 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.
|
|
5440
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5370
5441
|
*/
|
|
5371
|
-
|
|
5372
|
-
/** Total refunded amount for the line item. */
|
|
5373
|
-
totalRefundedAmount?: Price;
|
|
5442
|
+
externalRefund?: boolean;
|
|
5374
5443
|
}
|
|
5375
|
-
interface
|
|
5444
|
+
interface RefundSideEffects {
|
|
5445
|
+
/** Inventory restock details as part of this refund. */
|
|
5446
|
+
restockInfo?: RestockInfo;
|
|
5447
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
5448
|
+
sendOrderRefundedEmail?: boolean;
|
|
5376
5449
|
/**
|
|
5377
|
-
*
|
|
5450
|
+
* Custom message added to the refund confirmation email.
|
|
5378
5451
|
* @minLength 1
|
|
5379
|
-
* @maxLength
|
|
5452
|
+
* @maxLength 1000
|
|
5380
5453
|
*/
|
|
5381
|
-
|
|
5454
|
+
customMessage?: string | null;
|
|
5455
|
+
}
|
|
5456
|
+
interface RestockInfo {
|
|
5457
|
+
/** Restock type. */
|
|
5458
|
+
type?: RestockTypeWithLiterals;
|
|
5382
5459
|
/**
|
|
5383
|
-
*
|
|
5460
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
5384
5461
|
* @maxSize 300
|
|
5385
5462
|
*/
|
|
5386
|
-
|
|
5387
|
-
/** Should include shipping in refund calculation */
|
|
5388
|
-
refundShipping?: boolean;
|
|
5463
|
+
items?: RestockItem[];
|
|
5389
5464
|
}
|
|
5390
|
-
|
|
5465
|
+
declare enum RestockType {
|
|
5466
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5467
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5468
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5469
|
+
}
|
|
5470
|
+
/** @enumType */
|
|
5471
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5472
|
+
interface RestockItem {
|
|
5391
5473
|
/**
|
|
5392
|
-
* ID of the line item being
|
|
5474
|
+
* ID of the line item being restocked.
|
|
5393
5475
|
* @format GUID
|
|
5394
5476
|
*/
|
|
5395
|
-
|
|
5477
|
+
lineItemId?: string;
|
|
5396
5478
|
/**
|
|
5397
|
-
*
|
|
5479
|
+
* Line item quantity being restocked.
|
|
5398
5480
|
* @min 1
|
|
5399
5481
|
* @max 100000
|
|
5400
5482
|
*/
|
|
5401
5483
|
quantity?: number;
|
|
5402
5484
|
}
|
|
5403
|
-
interface
|
|
5404
|
-
/**
|
|
5405
|
-
|
|
5406
|
-
/**
|
|
5407
|
-
|
|
5408
|
-
/**
|
|
5409
|
-
|
|
5410
|
-
/** Total cost of the order (without tax) */
|
|
5411
|
-
subtotal?: Price;
|
|
5412
|
-
/** Total shipping cost for order */
|
|
5413
|
-
shipping?: Price;
|
|
5414
|
-
/** Previous refund given on that order */
|
|
5415
|
-
previouslyRefundedAmount?: Price;
|
|
5416
|
-
/**
|
|
5417
|
-
* The refundable items of that order
|
|
5418
|
-
* @maxSize 300
|
|
5419
|
-
*/
|
|
5420
|
-
items?: CalculateRefundItemResponse[];
|
|
5485
|
+
interface TriggerRefundResponse {
|
|
5486
|
+
/** All order's transactions after the refunds were added */
|
|
5487
|
+
orderTransactions?: OrderTransactions;
|
|
5488
|
+
/** Created refund ID */
|
|
5489
|
+
refundId?: string | null;
|
|
5490
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5491
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5421
5492
|
}
|
|
5422
|
-
|
|
5493
|
+
/**
|
|
5494
|
+
* A record of all payments and refunds associated with an order.
|
|
5495
|
+
*
|
|
5496
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5497
|
+
*/
|
|
5498
|
+
interface OrderTransactions {
|
|
5423
5499
|
/**
|
|
5424
|
-
*
|
|
5500
|
+
* Order ID.
|
|
5425
5501
|
* @format GUID
|
|
5426
5502
|
*/
|
|
5427
|
-
|
|
5428
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5429
|
-
price?: Price;
|
|
5430
|
-
}
|
|
5431
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
5503
|
+
orderId?: string;
|
|
5432
5504
|
/**
|
|
5433
|
-
*
|
|
5434
|
-
* @
|
|
5435
|
-
* @maxLength 100
|
|
5505
|
+
* Record of payments made to the merchant.
|
|
5506
|
+
* @maxSize 100
|
|
5436
5507
|
*/
|
|
5437
|
-
|
|
5508
|
+
payments?: Payment[];
|
|
5438
5509
|
/**
|
|
5439
|
-
*
|
|
5440
|
-
* @
|
|
5441
|
-
* @maxSize 100
|
|
5442
|
-
* @format GUID
|
|
5510
|
+
* Record of refunds made to the buyer.
|
|
5511
|
+
* @maxSize 300
|
|
5443
5512
|
*/
|
|
5444
|
-
|
|
5445
|
-
}
|
|
5446
|
-
interface VoidAuthorizedPaymentsResponse {
|
|
5447
|
-
/** All order's transactions after the void was triggered */
|
|
5448
|
-
orderTransactions?: OrderTransactions;
|
|
5513
|
+
refunds?: Refund[];
|
|
5449
5514
|
}
|
|
5450
|
-
interface
|
|
5515
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
5516
|
+
/** Regular payment details. */
|
|
5517
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5518
|
+
/** Gift card payment details. */
|
|
5519
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5520
|
+
/** Membership payment details. */
|
|
5521
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5451
5522
|
/**
|
|
5452
|
-
*
|
|
5453
|
-
* @
|
|
5454
|
-
* @
|
|
5523
|
+
* Payment ID.
|
|
5524
|
+
* @format GUID
|
|
5525
|
+
* @readonly
|
|
5526
|
+
*/
|
|
5527
|
+
id?: string | null;
|
|
5528
|
+
/** 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. */
|
|
5529
|
+
createdDate?: Date | null;
|
|
5530
|
+
/**
|
|
5531
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5532
|
+
* @readonly
|
|
5455
5533
|
*/
|
|
5456
|
-
|
|
5534
|
+
updatedDate?: Date | null;
|
|
5535
|
+
/** Payment amount. */
|
|
5536
|
+
amount?: Price;
|
|
5457
5537
|
/**
|
|
5458
|
-
*
|
|
5459
|
-
*
|
|
5460
|
-
*
|
|
5538
|
+
* Whether refunds for this payment are disabled.
|
|
5539
|
+
* + `true`: This payment is not refundable.
|
|
5540
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5461
5541
|
*/
|
|
5462
|
-
|
|
5463
|
-
}
|
|
5464
|
-
interface PaymentCapture {
|
|
5542
|
+
refundDisabled?: boolean;
|
|
5465
5543
|
/**
|
|
5466
|
-
*
|
|
5467
|
-
*
|
|
5544
|
+
* Whether receipt generation is allowed for this payment.
|
|
5545
|
+
* + `true`: This payment supports receipt generation.
|
|
5546
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5547
|
+
* @readonly
|
|
5468
5548
|
*/
|
|
5469
|
-
|
|
5549
|
+
supportReceiptGeneration?: boolean;
|
|
5550
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5551
|
+
cashRounding?: CashRoundingDetails;
|
|
5470
5552
|
/**
|
|
5471
|
-
*
|
|
5472
|
-
*
|
|
5553
|
+
* Overall payment status.
|
|
5554
|
+
*
|
|
5555
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
5473
5556
|
*/
|
|
5474
|
-
|
|
5475
|
-
}
|
|
5476
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
5477
|
-
/** All order's transactions after the capture was triggered */
|
|
5478
|
-
orderTransactions?: OrderTransactions;
|
|
5479
|
-
}
|
|
5480
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
5557
|
+
status?: PaymentStatusWithLiterals;
|
|
5481
5558
|
/**
|
|
5482
|
-
*
|
|
5483
|
-
* @
|
|
5484
|
-
* @maxLength 100
|
|
5559
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
5560
|
+
* @format GUID
|
|
5485
5561
|
*/
|
|
5486
|
-
|
|
5487
|
-
/** Amount to be charged */
|
|
5488
|
-
amount?: Price;
|
|
5562
|
+
chargeCorrelationId?: string | null;
|
|
5489
5563
|
}
|
|
5490
|
-
|
|
5491
|
-
|
|
5492
|
-
|
|
5564
|
+
/** @oneof */
|
|
5565
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5566
|
+
/** Regular payment details. */
|
|
5567
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5568
|
+
/** Gift card payment details. */
|
|
5569
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5570
|
+
/** Membership payment details. */
|
|
5571
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5493
5572
|
}
|
|
5494
|
-
|
|
5495
|
-
|
|
5496
|
-
orderId?: string;
|
|
5573
|
+
/** @oneof */
|
|
5574
|
+
interface PaymentReceiptInfoOneOf {
|
|
5497
5575
|
}
|
|
5498
|
-
|
|
5576
|
+
/** @oneof */
|
|
5577
|
+
interface PaymentStatusDetailsOneOf {
|
|
5499
5578
|
}
|
|
5500
|
-
interface
|
|
5579
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5580
|
+
/** Credit card details. */
|
|
5581
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5501
5582
|
/**
|
|
5502
|
-
*
|
|
5583
|
+
* Wix Payments order ID.
|
|
5503
5584
|
* @maxLength 100
|
|
5504
5585
|
*/
|
|
5505
|
-
|
|
5506
|
-
}
|
|
5507
|
-
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
5508
|
-
}
|
|
5509
|
-
interface SendBuyerPickupConfirmationEmailRequest {
|
|
5586
|
+
paymentOrderId?: string | null;
|
|
5510
5587
|
/**
|
|
5511
|
-
*
|
|
5588
|
+
* Payment gateway's transaction ID.
|
|
5589
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5512
5590
|
* @maxLength 100
|
|
5513
5591
|
*/
|
|
5514
|
-
|
|
5515
|
-
}
|
|
5516
|
-
interface SendBuyerPickupConfirmationEmailResponse {
|
|
5517
|
-
}
|
|
5518
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
5592
|
+
gatewayTransactionId?: string | null;
|
|
5519
5593
|
/**
|
|
5520
|
-
*
|
|
5521
|
-
*
|
|
5522
|
-
*
|
|
5594
|
+
* Payment method.
|
|
5595
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5596
|
+
* Non-exhaustive list of supported values:
|
|
5597
|
+
* + `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`
|
|
5598
|
+
* @maxLength 150
|
|
5599
|
+
* @deprecated Payment method.
|
|
5600
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5601
|
+
* Non-exhaustive list of supported values:
|
|
5602
|
+
* + `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`
|
|
5603
|
+
* @replacedBy payment_method_name
|
|
5604
|
+
* @targetRemovalDate 2026-07-01
|
|
5523
5605
|
*/
|
|
5524
|
-
|
|
5525
|
-
}
|
|
5526
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5527
|
-
}
|
|
5528
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
5606
|
+
paymentMethod?: string | null;
|
|
5529
5607
|
/**
|
|
5530
|
-
*
|
|
5608
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5531
5609
|
* @maxLength 100
|
|
5532
5610
|
*/
|
|
5533
|
-
|
|
5534
|
-
|
|
5535
|
-
|
|
5536
|
-
}
|
|
5537
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
5611
|
+
providerTransactionId?: string | null;
|
|
5612
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5613
|
+
offlinePayment?: boolean;
|
|
5538
5614
|
/**
|
|
5539
|
-
*
|
|
5540
|
-
* @
|
|
5541
|
-
* @
|
|
5615
|
+
* Payment status.
|
|
5616
|
+
* @deprecated Payment status.
|
|
5617
|
+
* @replacedBy payment.status
|
|
5618
|
+
* @targetRemovalDate 2026-11-01
|
|
5542
5619
|
*/
|
|
5543
|
-
|
|
5620
|
+
status?: TransactionStatusWithLiterals;
|
|
5621
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
5622
|
+
savedPaymentMethod?: boolean;
|
|
5623
|
+
/** Authorization details. */
|
|
5624
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5625
|
+
/**
|
|
5626
|
+
* Record of chargebacks made by the buyer.
|
|
5627
|
+
* @maxSize 6
|
|
5628
|
+
*/
|
|
5629
|
+
chargebacks?: Chargeback[];
|
|
5630
|
+
/** Platform fee amount associated with this payment. */
|
|
5631
|
+
platformFee?: Price;
|
|
5632
|
+
/**
|
|
5633
|
+
* Payment method with buyer and optional owner translations.
|
|
5634
|
+
* Non-exhaustive list of supported values:
|
|
5635
|
+
* + `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`
|
|
5636
|
+
*/
|
|
5637
|
+
paymentMethodName?: PaymentMethodName;
|
|
5544
5638
|
}
|
|
5545
|
-
|
|
5639
|
+
/** @oneof */
|
|
5640
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5641
|
+
/** Credit card details. */
|
|
5642
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5546
5643
|
}
|
|
5547
|
-
|
|
5644
|
+
declare enum TransactionStatus {
|
|
5645
|
+
UNDEFINED = "UNDEFINED",
|
|
5646
|
+
APPROVED = "APPROVED",
|
|
5647
|
+
PENDING = "PENDING",
|
|
5648
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5649
|
+
CANCELED = "CANCELED",
|
|
5650
|
+
DECLINED = "DECLINED",
|
|
5651
|
+
REFUNDED = "REFUNDED",
|
|
5652
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5653
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5654
|
+
VOIDED = "VOIDED"
|
|
5655
|
+
}
|
|
5656
|
+
/** @enumType */
|
|
5657
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5658
|
+
interface CreditCardPaymentMethodDetails {
|
|
5548
5659
|
/**
|
|
5549
|
-
*
|
|
5660
|
+
* The last 4 digits of the card number.
|
|
5661
|
+
* @maxLength 4
|
|
5662
|
+
*/
|
|
5663
|
+
lastFourDigits?: string | null;
|
|
5664
|
+
/**
|
|
5665
|
+
* Card issuer's brand.
|
|
5550
5666
|
* @maxLength 100
|
|
5551
5667
|
*/
|
|
5552
|
-
|
|
5553
|
-
}
|
|
5554
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5668
|
+
brand?: string | null;
|
|
5555
5669
|
}
|
|
5556
|
-
interface
|
|
5670
|
+
interface AuthorizationDetails {
|
|
5557
5671
|
/**
|
|
5558
|
-
*
|
|
5559
|
-
* @
|
|
5560
|
-
* @maxLength 100
|
|
5672
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5673
|
+
* @readonly
|
|
5561
5674
|
*/
|
|
5562
|
-
|
|
5675
|
+
delayedCapture?: boolean;
|
|
5676
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5677
|
+
authorizedDate?: Date | null;
|
|
5563
5678
|
/**
|
|
5564
|
-
*
|
|
5565
|
-
*
|
|
5566
|
-
* @
|
|
5679
|
+
* List of captures associated with payment
|
|
5680
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5681
|
+
* @maxSize 1
|
|
5567
5682
|
*/
|
|
5568
|
-
|
|
5569
|
-
/**
|
|
5570
|
-
|
|
5683
|
+
captures?: AuthorizationCapture[];
|
|
5684
|
+
/** Void associated with payment */
|
|
5685
|
+
void?: AuthorizationVoid;
|
|
5686
|
+
/** Scheduled action for this transaction */
|
|
5687
|
+
scheduledAction?: V1ScheduledAction;
|
|
5688
|
+
}
|
|
5689
|
+
interface AuthorizationCapture {
|
|
5571
5690
|
/**
|
|
5572
|
-
*
|
|
5691
|
+
* Capture ID.
|
|
5573
5692
|
* @format GUID
|
|
5693
|
+
* @readonly
|
|
5574
5694
|
*/
|
|
5575
|
-
|
|
5695
|
+
id?: string | null;
|
|
5696
|
+
/** Status of this capture action */
|
|
5697
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5698
|
+
/**
|
|
5699
|
+
* Amount of this capture
|
|
5700
|
+
* @immutable
|
|
5701
|
+
*/
|
|
5702
|
+
amount?: Price;
|
|
5703
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5704
|
+
createdDate?: Date | null;
|
|
5705
|
+
/** In case of status is FAILED may contain failure details */
|
|
5706
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5707
|
+
}
|
|
5708
|
+
declare enum AuthorizationCaptureStatus {
|
|
5709
|
+
/** Capture operation still in progress. */
|
|
5710
|
+
PENDING = "PENDING",
|
|
5711
|
+
/** Capture operation succeeded. */
|
|
5712
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5713
|
+
/** Capture operation failed. */
|
|
5714
|
+
FAILED = "FAILED"
|
|
5715
|
+
}
|
|
5716
|
+
/** @enumType */
|
|
5717
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5718
|
+
interface AuthorizationActionFailureDetails {
|
|
5719
|
+
/** @maxLength 100 */
|
|
5720
|
+
failureCode?: string;
|
|
5721
|
+
}
|
|
5722
|
+
interface AuthorizationVoid {
|
|
5723
|
+
/** Status of this void action */
|
|
5724
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5725
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5726
|
+
voidedDate?: Date | null;
|
|
5727
|
+
/** In case of status is FAILED may contain failure details */
|
|
5728
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5729
|
+
/** Reason of void action */
|
|
5730
|
+
reason?: ReasonWithLiterals;
|
|
5731
|
+
}
|
|
5732
|
+
declare enum AuthorizationVoidStatus {
|
|
5733
|
+
/** Void operation still in progress. */
|
|
5734
|
+
PENDING = "PENDING",
|
|
5735
|
+
/** Void operation succeeded. */
|
|
5736
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5737
|
+
/** Void operation failed. */
|
|
5738
|
+
FAILED = "FAILED"
|
|
5739
|
+
}
|
|
5740
|
+
/** @enumType */
|
|
5741
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5742
|
+
/** Reason the authorization was voided. */
|
|
5743
|
+
declare enum Reason {
|
|
5744
|
+
/** Authorization was voided by user. */
|
|
5745
|
+
MANUAL = "MANUAL",
|
|
5746
|
+
/** Authorization passed execution date. */
|
|
5747
|
+
SCHEDULED = "SCHEDULED"
|
|
5576
5748
|
}
|
|
5577
|
-
|
|
5749
|
+
/** @enumType */
|
|
5750
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5751
|
+
interface V1ScheduledAction {
|
|
5752
|
+
/** Type of the action. */
|
|
5753
|
+
actionType?: ActionTypeWithLiterals;
|
|
5754
|
+
/** The date and time of the action. */
|
|
5755
|
+
executionDate?: Date | null;
|
|
5578
5756
|
}
|
|
5579
|
-
|
|
5757
|
+
declare enum ActionType {
|
|
5758
|
+
VOID = "VOID",
|
|
5759
|
+
CAPTURE = "CAPTURE"
|
|
5760
|
+
}
|
|
5761
|
+
/** @enumType */
|
|
5762
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5763
|
+
interface Chargeback {
|
|
5580
5764
|
/**
|
|
5581
|
-
*
|
|
5765
|
+
* Chargeback ID.
|
|
5582
5766
|
* @format GUID
|
|
5767
|
+
* @readonly
|
|
5768
|
+
* @immutable
|
|
5583
5769
|
*/
|
|
5584
|
-
|
|
5770
|
+
id?: string;
|
|
5585
5771
|
/**
|
|
5586
|
-
*
|
|
5587
|
-
* @
|
|
5772
|
+
* 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.
|
|
5773
|
+
* @readonly
|
|
5774
|
+
* @immutable
|
|
5588
5775
|
*/
|
|
5589
|
-
|
|
5776
|
+
createdDate?: Date | null;
|
|
5590
5777
|
/**
|
|
5591
|
-
*
|
|
5592
|
-
* @
|
|
5593
|
-
* @maxLength 1000
|
|
5778
|
+
* 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.
|
|
5779
|
+
* @readonly
|
|
5594
5780
|
*/
|
|
5595
|
-
|
|
5596
|
-
}
|
|
5597
|
-
interface SendRefundEmailResponse {
|
|
5598
|
-
}
|
|
5599
|
-
interface SendFulfillmentEmailRequest {
|
|
5600
|
-
/** @format GUID */
|
|
5601
|
-
orderId?: string;
|
|
5602
|
-
/** @format GUID */
|
|
5603
|
-
fulfillerId?: string;
|
|
5604
|
-
}
|
|
5605
|
-
interface SendFulfillmentEmailResponse {
|
|
5606
|
-
}
|
|
5607
|
-
interface SendMerchantOrderReceivedPushRequest {
|
|
5781
|
+
updatedDate?: Date | null;
|
|
5608
5782
|
/**
|
|
5609
|
-
*
|
|
5610
|
-
* @
|
|
5783
|
+
* Amount.
|
|
5784
|
+
* @readonly
|
|
5785
|
+
* @immutable
|
|
5611
5786
|
*/
|
|
5612
|
-
|
|
5613
|
-
}
|
|
5614
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
5615
|
-
}
|
|
5616
|
-
interface PreviewEmailByTypeRequest {
|
|
5617
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
5618
|
-
}
|
|
5619
|
-
declare enum PreviewEmailType {
|
|
5620
|
-
ORDER_PLACED = "ORDER_PLACED",
|
|
5621
|
-
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
5622
|
-
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
5623
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
5624
|
-
}
|
|
5625
|
-
/** @enumType */
|
|
5626
|
-
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
5627
|
-
interface PreviewEmailByTypeResponse {
|
|
5628
|
-
emailPreview?: string;
|
|
5629
|
-
}
|
|
5630
|
-
interface PreviewRefundEmailRequest {
|
|
5787
|
+
amount?: Price;
|
|
5631
5788
|
/**
|
|
5632
|
-
*
|
|
5633
|
-
* @
|
|
5789
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5790
|
+
* @readonly
|
|
5634
5791
|
*/
|
|
5635
|
-
|
|
5636
|
-
/** Refund amount */
|
|
5637
|
-
refundAmount?: Price;
|
|
5638
|
-
/** Refund business details */
|
|
5639
|
-
details?: RefundDetails;
|
|
5792
|
+
reversalAmount?: Price;
|
|
5640
5793
|
/**
|
|
5641
|
-
*
|
|
5642
|
-
*
|
|
5643
|
-
*
|
|
5794
|
+
* Status.
|
|
5795
|
+
*
|
|
5796
|
+
* Default: `"APPROVED"`.
|
|
5644
5797
|
*/
|
|
5645
|
-
|
|
5798
|
+
status?: ChargebackStatusWithLiterals;
|
|
5646
5799
|
/**
|
|
5647
|
-
*
|
|
5800
|
+
* External chargeback ID.
|
|
5648
5801
|
* @format GUID
|
|
5802
|
+
* @readonly
|
|
5803
|
+
* @immutable
|
|
5649
5804
|
*/
|
|
5650
|
-
|
|
5805
|
+
externalId?: string | null;
|
|
5651
5806
|
}
|
|
5652
|
-
|
|
5653
|
-
|
|
5807
|
+
declare enum ChargebackStatus {
|
|
5808
|
+
/** Chargeback was approved. */
|
|
5809
|
+
APPROVED = "APPROVED",
|
|
5810
|
+
/** Chargeback was reversed. */
|
|
5811
|
+
REVERSED = "REVERSED"
|
|
5654
5812
|
}
|
|
5655
|
-
|
|
5813
|
+
/** @enumType */
|
|
5814
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5815
|
+
interface PaymentMethodName {
|
|
5656
5816
|
/**
|
|
5657
|
-
*
|
|
5658
|
-
* @maxLength
|
|
5817
|
+
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
5818
|
+
* @maxLength 150
|
|
5659
5819
|
*/
|
|
5660
|
-
|
|
5820
|
+
buyerLanguageName?: string | null;
|
|
5661
5821
|
/**
|
|
5662
|
-
*
|
|
5663
|
-
*
|
|
5664
|
-
*
|
|
5822
|
+
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
5823
|
+
*
|
|
5824
|
+
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
5825
|
+
* @maxLength 150
|
|
5665
5826
|
*/
|
|
5666
|
-
|
|
5667
|
-
}
|
|
5668
|
-
interface PreviewCancelEmailResponse {
|
|
5669
|
-
emailPreview?: string;
|
|
5670
|
-
}
|
|
5671
|
-
interface PreviewCancelRefundEmailRequest {
|
|
5827
|
+
siteLanguageName?: string | null;
|
|
5672
5828
|
/**
|
|
5673
|
-
*
|
|
5674
|
-
*
|
|
5829
|
+
* User-provided payment method name.
|
|
5830
|
+
*
|
|
5831
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5675
5832
|
*/
|
|
5676
|
-
|
|
5833
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5834
|
+
}
|
|
5835
|
+
interface GiftCardPaymentDetails {
|
|
5677
5836
|
/**
|
|
5678
|
-
*
|
|
5679
|
-
* @
|
|
5680
|
-
* @maxLength 1000
|
|
5837
|
+
* Gift card payment ID.
|
|
5838
|
+
* @maxLength 100
|
|
5681
5839
|
*/
|
|
5682
|
-
|
|
5683
|
-
/** Refund amount */
|
|
5684
|
-
refundAmount?: Price;
|
|
5840
|
+
giftCardPaymentId?: string;
|
|
5685
5841
|
/**
|
|
5686
|
-
*
|
|
5842
|
+
* ID of the app that created the gift card.
|
|
5687
5843
|
* @format GUID
|
|
5688
5844
|
*/
|
|
5689
|
-
|
|
5690
|
-
}
|
|
5691
|
-
interface PreviewCancelRefundEmailResponse {
|
|
5692
|
-
emailPreview?: string;
|
|
5693
|
-
}
|
|
5694
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
5695
|
-
}
|
|
5696
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5697
|
-
emailPreview?: string;
|
|
5698
|
-
}
|
|
5699
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
5700
|
-
}
|
|
5701
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
5702
|
-
emailPreview?: string;
|
|
5703
|
-
}
|
|
5704
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
5705
|
-
}
|
|
5706
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
5707
|
-
emailPreview?: string;
|
|
5708
|
-
}
|
|
5709
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
5710
|
-
}
|
|
5711
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
5712
|
-
emailPreview?: string;
|
|
5713
|
-
}
|
|
5714
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
5715
|
-
}
|
|
5716
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
5717
|
-
emailPreview?: string;
|
|
5718
|
-
}
|
|
5719
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
5720
|
-
/** Emitted on a meta site creation. */
|
|
5721
|
-
siteCreated?: SiteCreated;
|
|
5722
|
-
/** Emitted on a meta site transfer completion. */
|
|
5723
|
-
siteTransferred?: SiteTransferred;
|
|
5724
|
-
/** Emitted on a meta site deletion. */
|
|
5725
|
-
siteDeleted?: SiteDeleted;
|
|
5726
|
-
/** Emitted on a meta site restoration. */
|
|
5727
|
-
siteUndeleted?: SiteUndeleted;
|
|
5728
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5729
|
-
sitePublished?: SitePublished;
|
|
5730
|
-
/** Emitted on a meta site unpublish. */
|
|
5731
|
-
siteUnpublished?: SiteUnpublished;
|
|
5732
|
-
/** Emitted when meta site is marked as template. */
|
|
5733
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5734
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5735
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5736
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5737
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5738
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5739
|
-
serviceRemoved?: ServiceRemoved;
|
|
5740
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5741
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5742
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5743
|
-
hardDeleted?: SiteHardDeleted;
|
|
5744
|
-
/** Emitted on a namespace change. */
|
|
5745
|
-
namespaceChanged?: NamespaceChanged;
|
|
5746
|
-
/** Emitted when Studio is attached. */
|
|
5747
|
-
studioAssigned?: StudioAssigned;
|
|
5748
|
-
/** Emitted when Studio is detached. */
|
|
5749
|
-
studioUnassigned?: StudioUnassigned;
|
|
5750
|
-
/**
|
|
5751
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5752
|
-
* the actual URL.
|
|
5753
|
-
*
|
|
5754
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5755
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5756
|
-
*/
|
|
5757
|
-
urlChanged?: SiteUrlChanged;
|
|
5758
|
-
/** Site is marked as PurgedExternally */
|
|
5759
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5760
|
-
/** Emitted when Odeditor is attached. */
|
|
5761
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5762
|
-
/** Emitted when Odeditor is detached. */
|
|
5763
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5764
|
-
/** Emitted when Picasso is attached. */
|
|
5765
|
-
picassoAssigned?: PicassoAssigned;
|
|
5766
|
-
/** Emitted when Picasso is detached. */
|
|
5767
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5768
|
-
/** Emitted when Wixel is attached. */
|
|
5769
|
-
wixelAssigned?: WixelAssigned;
|
|
5770
|
-
/** Emitted when Wixel is detached. */
|
|
5771
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5772
|
-
/** Emitted when StudioTwo is attached. */
|
|
5773
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5774
|
-
/** Emitted when StudioTwo is detached. */
|
|
5775
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5776
|
-
/** Emitted when media from user domain is enabled. */
|
|
5777
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5778
|
-
/** Emitted when media from user domain is disabled. */
|
|
5779
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5780
|
-
/** Emitted when Editorless is attached. */
|
|
5781
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5782
|
-
/** Emitted when Editorless is detached. */
|
|
5783
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5845
|
+
appId?: string;
|
|
5784
5846
|
/**
|
|
5785
|
-
*
|
|
5786
|
-
* @
|
|
5847
|
+
* Whether the gift card is voided.
|
|
5848
|
+
* @readonly
|
|
5849
|
+
* @deprecated Whether the gift card is voided.
|
|
5850
|
+
* @replacedBy payment.status
|
|
5851
|
+
* @targetRemovalDate 2026-11-01
|
|
5787
5852
|
*/
|
|
5788
|
-
|
|
5789
|
-
/** A meta site version. Monotonically increasing. */
|
|
5790
|
-
version?: string;
|
|
5791
|
-
/** A timestamp of the event. */
|
|
5792
|
-
timestamp?: string;
|
|
5853
|
+
voided?: boolean;
|
|
5793
5854
|
/**
|
|
5794
|
-
*
|
|
5795
|
-
*
|
|
5796
|
-
* @
|
|
5855
|
+
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
5856
|
+
* @maxLength 30
|
|
5857
|
+
* @immutable
|
|
5797
5858
|
*/
|
|
5798
|
-
|
|
5859
|
+
obfuscatedCode?: string | null;
|
|
5799
5860
|
}
|
|
5800
|
-
|
|
5801
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5802
|
-
/** Emitted on a meta site creation. */
|
|
5803
|
-
siteCreated?: SiteCreated;
|
|
5804
|
-
/** Emitted on a meta site transfer completion. */
|
|
5805
|
-
siteTransferred?: SiteTransferred;
|
|
5806
|
-
/** Emitted on a meta site deletion. */
|
|
5807
|
-
siteDeleted?: SiteDeleted;
|
|
5808
|
-
/** Emitted on a meta site restoration. */
|
|
5809
|
-
siteUndeleted?: SiteUndeleted;
|
|
5810
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5811
|
-
sitePublished?: SitePublished;
|
|
5812
|
-
/** Emitted on a meta site unpublish. */
|
|
5813
|
-
siteUnpublished?: SiteUnpublished;
|
|
5814
|
-
/** Emitted when meta site is marked as template. */
|
|
5815
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5816
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5817
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5818
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5819
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5820
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5821
|
-
serviceRemoved?: ServiceRemoved;
|
|
5822
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5823
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5824
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5825
|
-
hardDeleted?: SiteHardDeleted;
|
|
5826
|
-
/** Emitted on a namespace change. */
|
|
5827
|
-
namespaceChanged?: NamespaceChanged;
|
|
5828
|
-
/** Emitted when Studio is attached. */
|
|
5829
|
-
studioAssigned?: StudioAssigned;
|
|
5830
|
-
/** Emitted when Studio is detached. */
|
|
5831
|
-
studioUnassigned?: StudioUnassigned;
|
|
5861
|
+
interface MembershipPaymentDetails {
|
|
5832
5862
|
/**
|
|
5833
|
-
*
|
|
5834
|
-
*
|
|
5835
|
-
*
|
|
5836
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5837
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5863
|
+
* Membership ID.
|
|
5864
|
+
* @maxLength 200
|
|
5838
5865
|
*/
|
|
5839
|
-
|
|
5840
|
-
/** Site is marked as PurgedExternally */
|
|
5841
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5842
|
-
/** Emitted when Odeditor is attached. */
|
|
5843
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5844
|
-
/** Emitted when Odeditor is detached. */
|
|
5845
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5846
|
-
/** Emitted when Picasso is attached. */
|
|
5847
|
-
picassoAssigned?: PicassoAssigned;
|
|
5848
|
-
/** Emitted when Picasso is detached. */
|
|
5849
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5850
|
-
/** Emitted when Wixel is attached. */
|
|
5851
|
-
wixelAssigned?: WixelAssigned;
|
|
5852
|
-
/** Emitted when Wixel is detached. */
|
|
5853
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5854
|
-
/** Emitted when StudioTwo is attached. */
|
|
5855
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5856
|
-
/** Emitted when StudioTwo is detached. */
|
|
5857
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5858
|
-
/** Emitted when media from user domain is enabled. */
|
|
5859
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5860
|
-
/** Emitted when media from user domain is disabled. */
|
|
5861
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5862
|
-
/** Emitted when Editorless is attached. */
|
|
5863
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5864
|
-
/** Emitted when Editorless is detached. */
|
|
5865
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5866
|
-
}
|
|
5867
|
-
interface Asset {
|
|
5866
|
+
membershipId?: string;
|
|
5868
5867
|
/**
|
|
5869
|
-
*
|
|
5870
|
-
* @
|
|
5868
|
+
* ID of the line item this membership applies to.
|
|
5869
|
+
* @minLength 1
|
|
5870
|
+
* @maxLength 100
|
|
5871
5871
|
*/
|
|
5872
|
-
|
|
5872
|
+
lineItemId?: string;
|
|
5873
5873
|
/**
|
|
5874
|
-
*
|
|
5875
|
-
* @
|
|
5874
|
+
* Payment status.
|
|
5875
|
+
* @deprecated Payment status.
|
|
5876
|
+
* @replacedBy payment.status
|
|
5877
|
+
* @targetRemovalDate 2026-11-01
|
|
5876
5878
|
*/
|
|
5877
|
-
|
|
5878
|
-
/**
|
|
5879
|
-
|
|
5879
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5880
|
+
/** Membership name. */
|
|
5881
|
+
name?: MembershipName;
|
|
5882
|
+
/**
|
|
5883
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5884
|
+
* @minLength 1
|
|
5885
|
+
* @maxLength 100
|
|
5886
|
+
*/
|
|
5887
|
+
externalTransactionId?: string | null;
|
|
5888
|
+
/**
|
|
5889
|
+
* Whether the membership is voided.
|
|
5890
|
+
* @readonly
|
|
5891
|
+
* @deprecated Whether the membership is voided.
|
|
5892
|
+
* @replacedBy payment.status
|
|
5893
|
+
* @targetRemovalDate 2026-11-01
|
|
5894
|
+
*/
|
|
5895
|
+
voided?: boolean;
|
|
5896
|
+
/**
|
|
5897
|
+
* ID of the application providing this payment option.
|
|
5898
|
+
* @format GUID
|
|
5899
|
+
*/
|
|
5900
|
+
providerAppId?: string;
|
|
5901
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5902
|
+
futureMembership?: FutureMembershipDetails;
|
|
5880
5903
|
}
|
|
5881
|
-
declare enum
|
|
5882
|
-
|
|
5883
|
-
|
|
5884
|
-
|
|
5885
|
-
|
|
5886
|
-
|
|
5904
|
+
declare enum MembershipPaymentStatus {
|
|
5905
|
+
/** Payment was charged. */
|
|
5906
|
+
CHARGED = "CHARGED",
|
|
5907
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5908
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5909
|
+
/** Payment is pending. */
|
|
5910
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5911
|
+
/** Payment was voided. */
|
|
5912
|
+
VOIDED = "VOIDED"
|
|
5887
5913
|
}
|
|
5888
5914
|
/** @enumType */
|
|
5889
|
-
type
|
|
5890
|
-
interface
|
|
5915
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5916
|
+
interface FutureMembershipDetails {
|
|
5891
5917
|
/**
|
|
5892
|
-
*
|
|
5893
|
-
* @
|
|
5918
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
5919
|
+
* @format GUID
|
|
5894
5920
|
*/
|
|
5895
|
-
|
|
5921
|
+
lineItemId?: string;
|
|
5896
5922
|
/**
|
|
5897
|
-
*
|
|
5898
|
-
* @
|
|
5923
|
+
* ID of the benefit the future membership will grant.
|
|
5924
|
+
* @maxLength 200
|
|
5899
5925
|
*/
|
|
5900
|
-
|
|
5901
|
-
|
|
5902
|
-
|
|
5926
|
+
benefitId?: string;
|
|
5927
|
+
}
|
|
5928
|
+
interface WixReceiptInfo {
|
|
5903
5929
|
/**
|
|
5904
|
-
*
|
|
5905
|
-
*
|
|
5906
|
-
* In case of a creation from a template it's a template id.
|
|
5907
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5930
|
+
* Receipt ID
|
|
5908
5931
|
* @format GUID
|
|
5909
5932
|
*/
|
|
5910
|
-
|
|
5933
|
+
receiptId?: string;
|
|
5911
5934
|
/**
|
|
5912
|
-
*
|
|
5913
|
-
* @
|
|
5935
|
+
* Display number of receipt
|
|
5936
|
+
* @minLength 1
|
|
5937
|
+
* @maxLength 40
|
|
5914
5938
|
*/
|
|
5915
|
-
|
|
5916
|
-
/** A namespace. */
|
|
5917
|
-
namespace?: NamespaceWithLiterals;
|
|
5918
|
-
}
|
|
5919
|
-
declare enum SiteCreatedContext {
|
|
5920
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5921
|
-
OTHER = "OTHER",
|
|
5922
|
-
/** A meta site was created from template. */
|
|
5923
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5924
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
5925
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5926
|
-
/** A copy of existing meta site. */
|
|
5927
|
-
DUPLICATE = "DUPLICATE",
|
|
5928
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5929
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5930
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
5931
|
-
FLASH = "FLASH"
|
|
5939
|
+
displayNumber?: string | null;
|
|
5932
5940
|
}
|
|
5933
|
-
|
|
5934
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5935
|
-
declare enum Namespace {
|
|
5936
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5937
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5938
|
-
WIX = "WIX",
|
|
5939
|
-
/** 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. */
|
|
5940
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
5941
|
-
/** 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. */
|
|
5942
|
-
ALBUMS = "ALBUMS",
|
|
5943
|
-
/** 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. */
|
|
5944
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5945
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5946
|
-
HOTELS = "HOTELS",
|
|
5947
|
-
/** 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. */
|
|
5948
|
-
CLUBS = "CLUBS",
|
|
5949
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5950
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5941
|
+
interface ExternalReceiptInfo {
|
|
5951
5942
|
/**
|
|
5952
|
-
*
|
|
5953
|
-
*
|
|
5943
|
+
* External receipt ID
|
|
5944
|
+
* @maxLength 100
|
|
5954
5945
|
*/
|
|
5955
|
-
|
|
5956
|
-
/** 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. */
|
|
5957
|
-
LOGOS = "LOGOS",
|
|
5958
|
-
/** 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. */
|
|
5959
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5960
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5961
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5962
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5963
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5946
|
+
receiptId?: string | null;
|
|
5964
5947
|
/**
|
|
5965
|
-
*
|
|
5966
|
-
*
|
|
5967
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5948
|
+
* ID of the app providing the receipt
|
|
5949
|
+
* @format GUID
|
|
5968
5950
|
*/
|
|
5969
|
-
|
|
5951
|
+
appId?: string | null;
|
|
5970
5952
|
/**
|
|
5971
|
-
*
|
|
5972
|
-
*
|
|
5973
|
-
*
|
|
5953
|
+
* Display number of receipt
|
|
5954
|
+
* @minLength 1
|
|
5955
|
+
* @maxLength 40
|
|
5974
5956
|
*/
|
|
5975
|
-
|
|
5976
|
-
|
|
5977
|
-
|
|
5978
|
-
/** It is to be used in the Business First efforts. */
|
|
5979
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5980
|
-
/** Bookings business flow with no site. */
|
|
5981
|
-
ANYWHERE = "ANYWHERE",
|
|
5982
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
5983
|
-
HEADLESS = "HEADLESS",
|
|
5957
|
+
displayNumber?: string | null;
|
|
5958
|
+
}
|
|
5959
|
+
interface CashRoundingDetails {
|
|
5984
5960
|
/**
|
|
5985
|
-
*
|
|
5986
|
-
*
|
|
5961
|
+
* Payment amount before cash rounding was applied.
|
|
5962
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
5963
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
5987
5964
|
*/
|
|
5988
|
-
|
|
5989
|
-
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
5990
|
-
RISE = "RISE",
|
|
5965
|
+
unroundedAmount?: Price;
|
|
5991
5966
|
/**
|
|
5992
|
-
*
|
|
5993
|
-
*
|
|
5994
|
-
*
|
|
5967
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
5968
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
5969
|
+
* @readonly
|
|
5995
5970
|
*/
|
|
5996
|
-
|
|
5997
|
-
|
|
5998
|
-
|
|
5971
|
+
roundingAdjustment?: CashRounding;
|
|
5972
|
+
}
|
|
5973
|
+
declare enum PaymentStatus {
|
|
5974
|
+
/** Payment was charged successfully. */
|
|
5975
|
+
APPROVED = "APPROVED",
|
|
5976
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5977
|
+
PENDING = "PENDING",
|
|
5978
|
+
/** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
|
|
5979
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5980
|
+
/** Payment was canceled before it was charged. */
|
|
5981
|
+
CANCELED = "CANCELED",
|
|
5982
|
+
/** Payment was declined by the payment provider. */
|
|
5983
|
+
DECLINED = "DECLINED",
|
|
5984
|
+
/** Payment was fully refunded. */
|
|
5985
|
+
REFUNDED = "REFUNDED",
|
|
5986
|
+
/** Part of the payment amount was refunded. */
|
|
5987
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5988
|
+
/** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
|
|
5989
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5999
5990
|
/**
|
|
6000
|
-
*
|
|
6001
|
-
*
|
|
5991
|
+
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
5992
|
+
*
|
|
5993
|
+
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
6002
5994
|
*/
|
|
6003
|
-
|
|
6004
|
-
|
|
6005
|
-
|
|
6006
|
-
|
|
6007
|
-
|
|
5995
|
+
VOIDED = "VOIDED"
|
|
5996
|
+
}
|
|
5997
|
+
/** @enumType */
|
|
5998
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5999
|
+
interface CanceledStatusDetails {
|
|
6000
|
+
reason?: CanceledReasonWithLiterals;
|
|
6001
|
+
}
|
|
6002
|
+
declare enum CanceledReason {
|
|
6003
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
6004
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
6005
|
+
/** Payment was not completed by user and expired. */
|
|
6006
|
+
EXPIRED = "EXPIRED"
|
|
6007
|
+
}
|
|
6008
|
+
/** @enumType */
|
|
6009
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
6010
|
+
interface DeclinedStatusDetails {
|
|
6011
|
+
reason?: DeclinedReasonWithLiterals;
|
|
6012
|
+
}
|
|
6013
|
+
declare enum DeclinedReason {
|
|
6014
|
+
/** Corresponding charge failed. */
|
|
6015
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6016
|
+
/** Payment details expired. */
|
|
6017
|
+
EXPIRED = "EXPIRED",
|
|
6018
|
+
/** Insufficient funds. */
|
|
6019
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6020
|
+
/** Gift card was disabled before charge was attempted. */
|
|
6021
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
6022
|
+
}
|
|
6023
|
+
/** @enumType */
|
|
6024
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6025
|
+
interface VoidedStatusDetails {
|
|
6026
|
+
reason?: VoidedReasonWithLiterals;
|
|
6027
|
+
}
|
|
6028
|
+
declare enum VoidedReason {
|
|
6029
|
+
/** Payment was voided by merchant request. */
|
|
6030
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
6031
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
6032
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
6033
|
+
}
|
|
6034
|
+
/** @enumType */
|
|
6035
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
6036
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
6037
|
+
}
|
|
6038
|
+
/** @oneof */
|
|
6039
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
6040
|
+
}
|
|
6041
|
+
interface Refund {
|
|
6008
6042
|
/**
|
|
6009
|
-
*
|
|
6010
|
-
*
|
|
6043
|
+
* Refund ID.
|
|
6044
|
+
* @format GUID
|
|
6045
|
+
* @readonly
|
|
6011
6046
|
*/
|
|
6012
|
-
|
|
6013
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6014
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
6015
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6016
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
6017
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
6018
|
-
MIMIR = "MIMIR",
|
|
6019
|
-
/** Wix Twins platform. */
|
|
6020
|
-
TWINS = "TWINS",
|
|
6021
|
-
/** Wix Nano. */
|
|
6022
|
-
NANO = "NANO",
|
|
6023
|
-
/** Base44 headless sites. */
|
|
6024
|
-
BASE44 = "BASE44",
|
|
6025
|
-
/** Wix Channels Sites */
|
|
6026
|
-
CHANNELS = "CHANNELS",
|
|
6027
|
-
/** Nautilus platform. */
|
|
6028
|
-
NAUTILUS = "NAUTILUS",
|
|
6047
|
+
id?: string;
|
|
6029
6048
|
/**
|
|
6030
|
-
*
|
|
6031
|
-
*
|
|
6049
|
+
* List of transactions.
|
|
6050
|
+
* @maxSize 50
|
|
6032
6051
|
*/
|
|
6033
|
-
|
|
6034
|
-
/**
|
|
6035
|
-
|
|
6052
|
+
transactions?: RefundTransaction[];
|
|
6053
|
+
/** Refund business details. */
|
|
6054
|
+
details?: RefundDetails;
|
|
6036
6055
|
/**
|
|
6037
|
-
*
|
|
6038
|
-
*
|
|
6056
|
+
* 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.
|
|
6057
|
+
* @readonly
|
|
6058
|
+
* @immutable
|
|
6039
6059
|
*/
|
|
6040
|
-
|
|
6060
|
+
createdDate?: Date | null;
|
|
6041
6061
|
/**
|
|
6042
|
-
*
|
|
6043
|
-
*
|
|
6044
|
-
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
6045
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6062
|
+
* Aggregated refund summary.
|
|
6063
|
+
* @readonly
|
|
6046
6064
|
*/
|
|
6047
|
-
|
|
6065
|
+
summary?: AggregatedRefundSummary;
|
|
6048
6066
|
/**
|
|
6049
|
-
*
|
|
6050
|
-
*
|
|
6067
|
+
* ID of the app that initiated this refund.
|
|
6068
|
+
* @format GUID
|
|
6069
|
+
* @readonly
|
|
6070
|
+
* @immutable
|
|
6051
6071
|
*/
|
|
6052
|
-
|
|
6072
|
+
requestingServiceAppId?: string | null;
|
|
6053
6073
|
}
|
|
6054
|
-
|
|
6055
|
-
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
|
|
6056
|
-
/** Site transferred to another user. */
|
|
6057
|
-
interface SiteTransferred {
|
|
6074
|
+
interface RefundTransaction {
|
|
6058
6075
|
/**
|
|
6059
|
-
*
|
|
6076
|
+
* ID of the payment associated with this refund.
|
|
6060
6077
|
* @format GUID
|
|
6078
|
+
* @immutable
|
|
6061
6079
|
*/
|
|
6062
|
-
|
|
6080
|
+
paymentId?: string;
|
|
6063
6081
|
/**
|
|
6064
|
-
*
|
|
6065
|
-
* @
|
|
6082
|
+
* Refund amount.
|
|
6083
|
+
* @immutable
|
|
6066
6084
|
*/
|
|
6067
|
-
|
|
6068
|
-
|
|
6069
|
-
|
|
6070
|
-
|
|
6071
|
-
|
|
6072
|
-
deleteContext?: DeleteContext;
|
|
6073
|
-
}
|
|
6074
|
-
interface DeleteContext {
|
|
6075
|
-
/** When the meta site was deleted. */
|
|
6076
|
-
dateDeleted?: Date | null;
|
|
6077
|
-
/** A status. */
|
|
6078
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
6085
|
+
amount?: Price;
|
|
6086
|
+
/** Refund status. */
|
|
6087
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
6088
|
+
/** Optional details of current refund status. */
|
|
6089
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
6079
6090
|
/**
|
|
6080
|
-
*
|
|
6081
|
-
*
|
|
6091
|
+
* Payment gateway's refund ID.
|
|
6092
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
6093
|
+
* @format GUID
|
|
6082
6094
|
*/
|
|
6083
|
-
|
|
6095
|
+
gatewayRefundId?: string | null;
|
|
6096
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
6097
|
+
providerRefundId?: string | null;
|
|
6084
6098
|
/**
|
|
6085
|
-
*
|
|
6086
|
-
* @
|
|
6099
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
6100
|
+
* @immutable
|
|
6087
6101
|
*/
|
|
6088
|
-
|
|
6102
|
+
externalRefund?: boolean;
|
|
6089
6103
|
}
|
|
6090
|
-
|
|
6091
|
-
|
|
6092
|
-
|
|
6093
|
-
|
|
6094
|
-
|
|
6095
|
-
|
|
6104
|
+
/** Refund transaction status. */
|
|
6105
|
+
declare enum RefundStatus {
|
|
6106
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
6107
|
+
PENDING = "PENDING",
|
|
6108
|
+
/** Refund transaction succeeded. */
|
|
6109
|
+
SUCCEEDED = "SUCCEEDED",
|
|
6110
|
+
/** Refund transaction failed. */
|
|
6111
|
+
FAILED = "FAILED",
|
|
6112
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
6113
|
+
SCHEDULED = "SCHEDULED",
|
|
6114
|
+
/** Refund was initiated on payment provider side. */
|
|
6115
|
+
STARTED = "STARTED"
|
|
6096
6116
|
}
|
|
6097
6117
|
/** @enumType */
|
|
6098
|
-
type
|
|
6099
|
-
|
|
6100
|
-
interface SiteUndeleted {
|
|
6101
|
-
}
|
|
6102
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
6103
|
-
interface SitePublished {
|
|
6104
|
-
}
|
|
6105
|
-
interface SiteUnpublished {
|
|
6118
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
6119
|
+
interface RefundStatusInfo {
|
|
6106
6120
|
/**
|
|
6107
|
-
*
|
|
6108
|
-
*
|
|
6109
|
-
*
|
|
6121
|
+
* Reason code for the refund's current status.
|
|
6122
|
+
*
|
|
6123
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
6124
|
+
* @minLength 1
|
|
6125
|
+
* @maxLength 10
|
|
6110
6126
|
*/
|
|
6111
|
-
|
|
6112
|
-
|
|
6113
|
-
|
|
6114
|
-
|
|
6115
|
-
|
|
6127
|
+
paymentGatewayReasonCode?: string | null;
|
|
6128
|
+
/**
|
|
6129
|
+
* Free text explanation of current refund status.
|
|
6130
|
+
* @minLength 1
|
|
6131
|
+
* @maxLength 1000
|
|
6132
|
+
*/
|
|
6133
|
+
description?: string | null;
|
|
6116
6134
|
}
|
|
6117
|
-
|
|
6118
|
-
|
|
6119
|
-
|
|
6120
|
-
|
|
6121
|
-
|
|
6122
|
-
|
|
6123
|
-
|
|
6124
|
-
|
|
6125
|
-
|
|
6126
|
-
|
|
6127
|
-
|
|
6128
|
-
|
|
6129
|
-
|
|
6130
|
-
|
|
6131
|
-
|
|
6132
|
-
interface ServiceProvisioned {
|
|
6135
|
+
interface AggregatedRefundSummary {
|
|
6136
|
+
/** Total amount requested for refund. */
|
|
6137
|
+
requestedRefund?: Price;
|
|
6138
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
6139
|
+
pendingRefund?: Price;
|
|
6140
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
6141
|
+
refunded?: Price;
|
|
6142
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6143
|
+
failedRefundAmount?: Price;
|
|
6144
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6145
|
+
pending?: boolean;
|
|
6146
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6147
|
+
breakdown?: RefundItemsBreakdown;
|
|
6148
|
+
}
|
|
6149
|
+
interface RefundItemsBreakdown {
|
|
6133
6150
|
/**
|
|
6134
|
-
*
|
|
6135
|
-
* @
|
|
6151
|
+
* Refunded line items and the amount refunded for each.
|
|
6152
|
+
* @maxSize 300
|
|
6136
6153
|
*/
|
|
6137
|
-
|
|
6154
|
+
lineItems?: LineItemRefundSummary[];
|
|
6155
|
+
}
|
|
6156
|
+
interface LineItemRefundSummary {
|
|
6138
6157
|
/**
|
|
6139
|
-
*
|
|
6140
|
-
* @
|
|
6158
|
+
* ID of the refunded line item.
|
|
6159
|
+
* @format GUID
|
|
6141
6160
|
*/
|
|
6142
|
-
|
|
6161
|
+
lineItemId?: string;
|
|
6162
|
+
/** Total refunded amount for the line item. */
|
|
6163
|
+
totalRefundedAmount?: Price;
|
|
6164
|
+
}
|
|
6165
|
+
interface CalculateRefundRequest {
|
|
6143
6166
|
/**
|
|
6144
|
-
*
|
|
6145
|
-
* @
|
|
6167
|
+
* Order ID
|
|
6168
|
+
* @minLength 1
|
|
6169
|
+
* @maxLength 100
|
|
6146
6170
|
*/
|
|
6147
|
-
|
|
6171
|
+
ecomOrderId?: string;
|
|
6148
6172
|
/**
|
|
6149
|
-
*
|
|
6150
|
-
* @
|
|
6173
|
+
* Refunded line items and quantity
|
|
6174
|
+
* @maxSize 300
|
|
6151
6175
|
*/
|
|
6152
|
-
|
|
6176
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
6177
|
+
/** Should include shipping in refund calculation */
|
|
6178
|
+
refundShipping?: boolean;
|
|
6179
|
+
}
|
|
6180
|
+
interface CalculateRefundItemRequest {
|
|
6153
6181
|
/**
|
|
6154
|
-
*
|
|
6182
|
+
* ID of the line item being refunded
|
|
6155
6183
|
* @format GUID
|
|
6156
6184
|
*/
|
|
6157
|
-
|
|
6158
|
-
}
|
|
6159
|
-
interface ServiceRemoved {
|
|
6185
|
+
id?: string;
|
|
6160
6186
|
/**
|
|
6161
|
-
*
|
|
6162
|
-
* @
|
|
6187
|
+
* How much of that line item is being refunded
|
|
6188
|
+
* @min 1
|
|
6189
|
+
* @max 100000
|
|
6163
6190
|
*/
|
|
6164
|
-
|
|
6191
|
+
quantity?: number;
|
|
6192
|
+
}
|
|
6193
|
+
interface CalculateRefundResponse {
|
|
6194
|
+
/** Total refundable amount */
|
|
6195
|
+
total?: Price;
|
|
6196
|
+
/** Tax cost of the order */
|
|
6197
|
+
tax?: Price;
|
|
6198
|
+
/** Discount given for this order */
|
|
6199
|
+
discount?: Price;
|
|
6200
|
+
/** Total cost of the order (without tax) */
|
|
6201
|
+
subtotal?: Price;
|
|
6202
|
+
/** Total shipping cost for order */
|
|
6203
|
+
shipping?: Price;
|
|
6204
|
+
/** Previous refund given on that order */
|
|
6205
|
+
previouslyRefundedAmount?: Price;
|
|
6165
6206
|
/**
|
|
6166
|
-
*
|
|
6167
|
-
* @
|
|
6207
|
+
* The refundable items of that order
|
|
6208
|
+
* @maxSize 300
|
|
6168
6209
|
*/
|
|
6169
|
-
|
|
6210
|
+
items?: CalculateRefundItemResponse[];
|
|
6211
|
+
}
|
|
6212
|
+
interface CalculateRefundItemResponse {
|
|
6170
6213
|
/**
|
|
6171
|
-
*
|
|
6172
|
-
* @
|
|
6214
|
+
* Line item ID
|
|
6215
|
+
* @format GUID
|
|
6173
6216
|
*/
|
|
6174
|
-
|
|
6217
|
+
id?: string;
|
|
6218
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6219
|
+
price?: Price;
|
|
6175
6220
|
}
|
|
6176
|
-
|
|
6177
|
-
interface SiteRenamed {
|
|
6221
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
6178
6222
|
/**
|
|
6179
|
-
*
|
|
6180
|
-
* @
|
|
6223
|
+
* Wix eCommerce order ID
|
|
6224
|
+
* @minLength 1
|
|
6225
|
+
* @maxLength 100
|
|
6181
6226
|
*/
|
|
6182
|
-
|
|
6227
|
+
ecomOrderId: string;
|
|
6183
6228
|
/**
|
|
6184
|
-
*
|
|
6185
|
-
* @
|
|
6229
|
+
* Payment IDs
|
|
6230
|
+
* @minSize 1
|
|
6231
|
+
* @maxSize 100
|
|
6232
|
+
* @format GUID
|
|
6186
6233
|
*/
|
|
6187
|
-
|
|
6188
|
-
}
|
|
6189
|
-
/**
|
|
6190
|
-
* Hard deletion of the meta site.
|
|
6191
|
-
*
|
|
6192
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
6193
|
-
*/
|
|
6194
|
-
interface SiteHardDeleted {
|
|
6195
|
-
/** A deletion context. */
|
|
6196
|
-
deleteContext?: DeleteContext;
|
|
6197
|
-
}
|
|
6198
|
-
interface NamespaceChanged {
|
|
6199
|
-
/** A previous namespace. */
|
|
6200
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
6201
|
-
/** A new namespace. */
|
|
6202
|
-
newNamespace?: NamespaceWithLiterals;
|
|
6203
|
-
}
|
|
6204
|
-
/** Assigned Studio editor */
|
|
6205
|
-
interface StudioAssigned {
|
|
6206
|
-
}
|
|
6207
|
-
/** Unassigned Studio editor */
|
|
6208
|
-
interface StudioUnassigned {
|
|
6234
|
+
paymentIds: string[];
|
|
6209
6235
|
}
|
|
6210
|
-
|
|
6211
|
-
|
|
6212
|
-
|
|
6213
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
6214
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
6215
|
-
*
|
|
6216
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
6217
|
-
*/
|
|
6218
|
-
interface SiteUrlChanged {
|
|
6236
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
6237
|
+
/** All order's transactions after the void was triggered */
|
|
6238
|
+
orderTransactions?: OrderTransactions;
|
|
6219
6239
|
}
|
|
6220
|
-
|
|
6221
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
6222
|
-
* Consumed by other teams to remove relevant data.
|
|
6223
|
-
*/
|
|
6224
|
-
interface SitePurgedExternally {
|
|
6240
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
6225
6241
|
/**
|
|
6226
|
-
*
|
|
6242
|
+
* Wix eCommerce order ID
|
|
6243
|
+
* @minLength 1
|
|
6244
|
+
* @maxLength 100
|
|
6245
|
+
*/
|
|
6246
|
+
ecomOrderId: string;
|
|
6247
|
+
/**
|
|
6248
|
+
* Capture payments information
|
|
6249
|
+
* @minSize 1
|
|
6227
6250
|
* @maxSize 100
|
|
6228
|
-
* @deprecated
|
|
6229
|
-
* @targetRemovalDate 2025-04-15
|
|
6230
6251
|
*/
|
|
6231
|
-
|
|
6232
|
-
}
|
|
6233
|
-
/** Assigned Odeditor */
|
|
6234
|
-
interface OdeditorAssigned {
|
|
6235
|
-
}
|
|
6236
|
-
/** Unassigned Odeditor */
|
|
6237
|
-
interface OdeditorUnassigned {
|
|
6238
|
-
}
|
|
6239
|
-
/** Assigned Picasso editor */
|
|
6240
|
-
interface PicassoAssigned {
|
|
6241
|
-
}
|
|
6242
|
-
/** Unassigned Picasso */
|
|
6243
|
-
interface PicassoUnassigned {
|
|
6244
|
-
}
|
|
6245
|
-
/** Assigned Wixel */
|
|
6246
|
-
interface WixelAssigned {
|
|
6247
|
-
}
|
|
6248
|
-
/** Unassigned Wixel */
|
|
6249
|
-
interface WixelUnassigned {
|
|
6250
|
-
}
|
|
6251
|
-
/** Assigned StudioTwo */
|
|
6252
|
-
interface StudioTwoAssigned {
|
|
6253
|
-
}
|
|
6254
|
-
/** Unassigned StudioTwo */
|
|
6255
|
-
interface StudioTwoUnassigned {
|
|
6256
|
-
}
|
|
6257
|
-
/** Media from user domain is enabled. */
|
|
6258
|
-
interface UserDomainMediaEnabled {
|
|
6259
|
-
}
|
|
6260
|
-
/** Media from user domain is disabled. */
|
|
6261
|
-
interface UserDomainMediaDisabled {
|
|
6262
|
-
}
|
|
6263
|
-
/** Assigned Editorless */
|
|
6264
|
-
interface EditorlessAssigned {
|
|
6265
|
-
}
|
|
6266
|
-
/** Unassigned Editorless */
|
|
6267
|
-
interface EditorlessUnassigned {
|
|
6252
|
+
payments: PaymentCapture[];
|
|
6268
6253
|
}
|
|
6269
|
-
interface
|
|
6254
|
+
interface PaymentCapture {
|
|
6255
|
+
/**
|
|
6256
|
+
* Payment ID
|
|
6257
|
+
* @format GUID
|
|
6258
|
+
*/
|
|
6259
|
+
paymentId?: string | null;
|
|
6260
|
+
/**
|
|
6261
|
+
* Capture amount.
|
|
6262
|
+
* If not provided - full authorized amount will be captured.
|
|
6263
|
+
*/
|
|
6264
|
+
amount?: Price;
|
|
6270
6265
|
}
|
|
6271
|
-
interface
|
|
6272
|
-
|
|
6266
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
6267
|
+
/** All order's transactions after the capture was triggered */
|
|
6268
|
+
orderTransactions?: OrderTransactions;
|
|
6273
6269
|
}
|
|
6274
|
-
interface
|
|
6275
|
-
/**
|
|
6276
|
-
|
|
6277
|
-
|
|
6278
|
-
|
|
6270
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
6271
|
+
/**
|
|
6272
|
+
* Ecom Order ID.
|
|
6273
|
+
* @minLength 1
|
|
6274
|
+
* @maxLength 100
|
|
6275
|
+
*/
|
|
6276
|
+
ecomOrderId?: string;
|
|
6277
|
+
/** Amount to be charged */
|
|
6278
|
+
amount?: Price;
|
|
6279
6279
|
}
|
|
6280
|
-
|
|
6281
|
-
|
|
6282
|
-
|
|
6280
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
6281
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
6282
|
+
paymentGatewayOrderId?: string;
|
|
6283
6283
|
}
|
|
6284
|
-
|
|
6285
|
-
|
|
6286
|
-
|
|
6287
|
-
|
|
6284
|
+
interface V1TriggerReindexRequest {
|
|
6285
|
+
/** @format GUID */
|
|
6286
|
+
metasiteId?: string;
|
|
6287
|
+
/**
|
|
6288
|
+
* @minLength 1
|
|
6289
|
+
* @maxLength 100
|
|
6290
|
+
* @maxSize 100
|
|
6291
|
+
*/
|
|
6292
|
+
orderIds?: string[];
|
|
6288
6293
|
}
|
|
6289
|
-
interface
|
|
6294
|
+
interface V1TriggerReindexResponse {
|
|
6290
6295
|
}
|
|
6291
|
-
interface
|
|
6292
|
-
|
|
6296
|
+
interface V1TriggerReindexOrderRequest {
|
|
6297
|
+
/** @format GUID */
|
|
6298
|
+
metasiteId?: string;
|
|
6299
|
+
/**
|
|
6300
|
+
* @minLength 1
|
|
6301
|
+
* @maxLength 100
|
|
6302
|
+
*/
|
|
6303
|
+
orderId?: string;
|
|
6293
6304
|
}
|
|
6294
6305
|
interface DiffmatokyPayload {
|
|
6295
6306
|
left?: string;
|