@wix/auto_sdk_ecom_orders 1.0.322 → 1.0.324
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-B_W1TM1T.d.ts → ecom-v1-order-orders.universal-CioVnQwu.d.ts} +1711 -1699
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +89 -80
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +89 -80
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1712 -1700
- package/build/cjs/meta.js +89 -80
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-B_W1TM1T.d.mts → ecom-v1-order-orders.universal-CioVnQwu.d.mts} +1711 -1699
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +88 -80
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +88 -80
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1712 -1700
- package/build/es/meta.mjs +88 -80
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-4KAOT3ls.d.ts → ecom-v1-order-orders.universal-aVj7Mb1n.d.ts} +1901 -1800
- 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 +1902 -1801
- package/build/internal/es/{ecom-v1-order-orders.universal-4KAOT3ls.d.mts → ecom-v1-order-orders.universal-aVj7Mb1n.d.mts} +1901 -1800
- 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 +1902 -1801
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
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, ee as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ei as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, ej as RecordManuallyCollectedPaymentRequest$1, em as RecordManuallyCollectedPaymentResponse$1, en as MarkOrderAsPaidRequest$1, eo as MarkOrderAsPaidResponse$1, ep as BulkMarkOrdersAsPaidRequest$1, eq as BulkMarkOrdersAsPaidResponse$1, ev as GetRefundabilityStatusRequest$1, ew as GetRefundabilityStatusResponse$1, ez as CreatePaymentGatewayOrderRequest$1, eB as CreatePaymentGatewayOrderResponse$1, eC as ChargeMembershipsRequest$1, eF as ChargeMembershipsResponse$1, eG as TriggerRefundRequest$1, eQ as TriggerRefundResponse$1, fp as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fq 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-CioVnQwu.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -1739,6 +1739,7 @@ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
|
1739
1739
|
merchantDiscount?: MerchantDiscount;
|
|
1740
1740
|
/** Automatic discount applied by the system based on configured discount rules. */
|
|
1741
1741
|
discountRule?: DiscountRule;
|
|
1742
|
+
/** Discount type. */
|
|
1742
1743
|
discountType?: DiscountTypeWithLiterals;
|
|
1743
1744
|
/**
|
|
1744
1745
|
* __Deprecated.__ Use `lineItemDiscounts` instead.
|
|
@@ -1786,16 +1787,24 @@ declare enum DiscountType {
|
|
|
1786
1787
|
/** @enumType */
|
|
1787
1788
|
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1788
1789
|
/** Coupon */
|
|
1789
|
-
interface Coupon {
|
|
1790
|
+
interface Coupon extends CouponDiscountValueOneOf {
|
|
1790
1791
|
/** Coupon ID. */
|
|
1791
1792
|
id?: string;
|
|
1792
1793
|
/** Coupon code. */
|
|
1793
1794
|
code?: string;
|
|
1794
1795
|
/** Coupon name. */
|
|
1795
1796
|
name?: string;
|
|
1796
|
-
/**
|
|
1797
|
+
/** Total amount the coupon took off. */
|
|
1797
1798
|
amount?: Price;
|
|
1798
1799
|
}
|
|
1800
|
+
/** @oneof */
|
|
1801
|
+
interface CouponDiscountValueOneOf {
|
|
1802
|
+
}
|
|
1803
|
+
/** How a coupon's or discount rule's discount value is expressed. */
|
|
1804
|
+
declare enum DiscountValueType {
|
|
1805
|
+
}
|
|
1806
|
+
/** @enumType */
|
|
1807
|
+
type DiscountValueTypeWithLiterals = DiscountValueType;
|
|
1799
1808
|
/** Discount applied manually by the merchant through the dashboard. */
|
|
1800
1809
|
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1801
1810
|
/** Predefined discount reason. */
|
|
@@ -1829,7 +1838,7 @@ declare enum DiscountReason {
|
|
|
1829
1838
|
}
|
|
1830
1839
|
/** @enumType */
|
|
1831
1840
|
type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1832
|
-
interface DiscountRule {
|
|
1841
|
+
interface DiscountRule extends DiscountRuleDiscountValueOneOf {
|
|
1833
1842
|
/**
|
|
1834
1843
|
* Discount rule ID
|
|
1835
1844
|
* @format GUID
|
|
@@ -1837,9 +1846,12 @@ interface DiscountRule {
|
|
|
1837
1846
|
id?: string;
|
|
1838
1847
|
/** Discount rule name */
|
|
1839
1848
|
name?: DiscountRuleName;
|
|
1840
|
-
/**
|
|
1849
|
+
/** Total amount the discount rule took off. */
|
|
1841
1850
|
amount?: Price;
|
|
1842
1851
|
}
|
|
1852
|
+
/** @oneof */
|
|
1853
|
+
interface DiscountRuleDiscountValueOneOf {
|
|
1854
|
+
}
|
|
1843
1855
|
interface DiscountRuleName {
|
|
1844
1856
|
/**
|
|
1845
1857
|
* Original discount rule name (in site's default language).
|
|
@@ -4108,2176 +4120,2176 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
4108
4120
|
*/
|
|
4109
4121
|
jobId?: string;
|
|
4110
4122
|
}
|
|
4111
|
-
interface
|
|
4123
|
+
interface V1TriggerReindexRequest {
|
|
4112
4124
|
/** @format GUID */
|
|
4113
|
-
|
|
4114
|
-
}
|
|
4115
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
4116
|
-
}
|
|
4117
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
4125
|
+
metasiteId?: string;
|
|
4118
4126
|
/**
|
|
4119
4127
|
* @minLength 1
|
|
4120
4128
|
* @maxLength 100
|
|
4129
|
+
* @maxSize 100
|
|
4121
4130
|
*/
|
|
4122
|
-
|
|
4131
|
+
orderIds?: string[];
|
|
4123
4132
|
}
|
|
4124
|
-
interface
|
|
4133
|
+
interface V1TriggerReindexResponse {
|
|
4125
4134
|
}
|
|
4126
|
-
interface
|
|
4135
|
+
interface V1TriggerReindexOrderRequest {
|
|
4136
|
+
/** @format GUID */
|
|
4137
|
+
metasiteId?: string;
|
|
4127
4138
|
/**
|
|
4128
4139
|
* @minLength 1
|
|
4129
4140
|
* @maxLength 100
|
|
4130
4141
|
*/
|
|
4131
4142
|
orderId?: string;
|
|
4132
4143
|
}
|
|
4133
|
-
interface
|
|
4134
|
-
}
|
|
4135
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
4136
|
-
/**
|
|
4137
|
-
* IDs of orders to send pickup emails for.
|
|
4138
|
-
* @minSize 1
|
|
4139
|
-
* @maxSize 300
|
|
4140
|
-
*/
|
|
4141
|
-
orderIds?: string[];
|
|
4142
|
-
}
|
|
4143
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
4144
|
-
}
|
|
4145
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
4144
|
+
interface PreparePaymentCollectionRequest {
|
|
4146
4145
|
/**
|
|
4146
|
+
* Ecom order ID.
|
|
4147
4147
|
* @minLength 1
|
|
4148
4148
|
* @maxLength 100
|
|
4149
4149
|
*/
|
|
4150
|
-
|
|
4151
|
-
|
|
4152
|
-
|
|
4153
|
-
}
|
|
4154
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
4150
|
+
ecomOrderId: string;
|
|
4151
|
+
/** Amount to collect */
|
|
4152
|
+
amount: Price;
|
|
4155
4153
|
/**
|
|
4156
|
-
*
|
|
4157
|
-
*
|
|
4158
|
-
*
|
|
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.
|
|
4159
4157
|
*/
|
|
4160
|
-
|
|
4161
|
-
}
|
|
4162
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
4163
|
-
}
|
|
4164
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
4158
|
+
paymentGatewayOrderId?: string | null;
|
|
4165
4159
|
/**
|
|
4166
|
-
*
|
|
4167
|
-
*
|
|
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
|
|
4168
4166
|
*/
|
|
4169
|
-
|
|
4170
|
-
|
|
4171
|
-
|
|
4167
|
+
delayedCapture?: boolean;
|
|
4168
|
+
/** Delayed capture payment settings */
|
|
4169
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4172
4170
|
}
|
|
4173
|
-
interface
|
|
4174
|
-
/**
|
|
4175
|
-
* The ID of order that is canceled/refunded
|
|
4176
|
-
* @minLength 1
|
|
4177
|
-
* @maxLength 100
|
|
4178
|
-
*/
|
|
4179
|
-
orderId?: string;
|
|
4171
|
+
interface RedirectUrls {
|
|
4180
4172
|
/**
|
|
4181
|
-
*
|
|
4182
|
-
* @
|
|
4183
|
-
* @maxLength 1000
|
|
4173
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4174
|
+
* @format WEB_URL
|
|
4184
4175
|
*/
|
|
4185
|
-
|
|
4186
|
-
/** Refund amount */
|
|
4187
|
-
refundAmount?: Price;
|
|
4176
|
+
successUrl?: string | null;
|
|
4188
4177
|
/**
|
|
4189
|
-
*
|
|
4190
|
-
* @format
|
|
4178
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4179
|
+
* @format WEB_URL
|
|
4191
4180
|
*/
|
|
4192
|
-
|
|
4193
|
-
}
|
|
4194
|
-
interface SendCancelRefundEmailResponse {
|
|
4195
|
-
}
|
|
4196
|
-
interface SendRefundEmailRequest {
|
|
4181
|
+
cancelUrl?: string | null;
|
|
4197
4182
|
/**
|
|
4198
|
-
*
|
|
4199
|
-
* @format
|
|
4183
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4184
|
+
* @format WEB_URL
|
|
4200
4185
|
*/
|
|
4201
|
-
|
|
4186
|
+
errorUrl?: string | null;
|
|
4202
4187
|
/**
|
|
4203
|
-
*
|
|
4204
|
-
* @format
|
|
4188
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4189
|
+
* @format WEB_URL
|
|
4205
4190
|
*/
|
|
4206
|
-
|
|
4191
|
+
pendingUrl?: string | null;
|
|
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;
|
|
4198
|
+
}
|
|
4199
|
+
declare enum ScheduledAction {
|
|
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"
|
|
4204
|
+
}
|
|
4205
|
+
/** @enumType */
|
|
4206
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4207
|
+
interface Duration {
|
|
4207
4208
|
/**
|
|
4208
|
-
*
|
|
4209
|
-
* @
|
|
4210
|
-
* @maxLength 1000
|
|
4209
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4210
|
+
* @min 1
|
|
4211
4211
|
*/
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
|
|
4212
|
+
count?: number;
|
|
4213
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4214
|
+
unit?: DurationUnitWithLiterals;
|
|
4215
4215
|
}
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
fulfillerId?: string;
|
|
4216
|
+
declare enum DurationUnit {
|
|
4217
|
+
MINUTES = "MINUTES",
|
|
4218
|
+
HOURS = "HOURS",
|
|
4219
|
+
DAYS = "DAYS"
|
|
4221
4220
|
}
|
|
4222
|
-
|
|
4221
|
+
/** @enumType */
|
|
4222
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4223
|
+
interface PreparePaymentCollectionResponse {
|
|
4224
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4225
|
+
paymentGatewayOrderId?: string;
|
|
4223
4226
|
}
|
|
4224
|
-
interface
|
|
4227
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4225
4228
|
/**
|
|
4229
|
+
* Ecom order ID.
|
|
4226
4230
|
* @minLength 1
|
|
4227
4231
|
* @maxLength 100
|
|
4228
4232
|
*/
|
|
4229
|
-
|
|
4230
|
-
}
|
|
4231
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
4233
|
+
ecomOrderId: string;
|
|
4232
4234
|
}
|
|
4233
|
-
interface
|
|
4234
|
-
|
|
4235
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4236
|
+
/** Payment collectability status */
|
|
4237
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4238
|
+
/** Collectable order amount */
|
|
4239
|
+
amount?: Price;
|
|
4235
4240
|
}
|
|
4236
|
-
declare enum
|
|
4237
|
-
|
|
4238
|
-
|
|
4239
|
-
|
|
4240
|
-
|
|
4241
|
+
declare enum PaymentCollectabilityStatus {
|
|
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"
|
|
4241
4255
|
}
|
|
4242
4256
|
/** @enumType */
|
|
4243
|
-
type
|
|
4244
|
-
interface
|
|
4245
|
-
emailPreview?: string;
|
|
4246
|
-
}
|
|
4247
|
-
interface PreviewRefundEmailRequest {
|
|
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 {
|
|
4248
4259
|
/**
|
|
4260
|
+
* Order ID.
|
|
4249
4261
|
* @minLength 1
|
|
4250
4262
|
* @maxLength 100
|
|
4251
4263
|
*/
|
|
4252
|
-
orderId
|
|
4253
|
-
/**
|
|
4254
|
-
|
|
4255
|
-
|
|
4256
|
-
|
|
4264
|
+
orderId: string;
|
|
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;
|
|
4257
4275
|
/**
|
|
4258
|
-
*
|
|
4276
|
+
* Custom payment method name provided by user.
|
|
4277
|
+
*
|
|
4278
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4259
4279
|
* @minLength 1
|
|
4260
|
-
* @maxLength
|
|
4280
|
+
* @maxLength 150
|
|
4261
4281
|
*/
|
|
4262
|
-
|
|
4282
|
+
custom?: string | null;
|
|
4283
|
+
}
|
|
4284
|
+
/** @oneof */
|
|
4285
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4286
|
+
/** Predefined payment method. */
|
|
4287
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4263
4288
|
/**
|
|
4264
|
-
*
|
|
4265
|
-
*
|
|
4289
|
+
* Custom payment method name provided by user.
|
|
4290
|
+
*
|
|
4291
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4292
|
+
* @minLength 1
|
|
4293
|
+
* @maxLength 150
|
|
4266
4294
|
*/
|
|
4267
|
-
|
|
4295
|
+
custom?: string | null;
|
|
4268
4296
|
}
|
|
4269
|
-
/**
|
|
4270
|
-
|
|
4297
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
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"
|
|
4305
|
+
}
|
|
4306
|
+
/** @enumType */
|
|
4307
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4308
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4309
|
+
}
|
|
4310
|
+
interface MarkOrderAsPaidRequest {
|
|
4271
4311
|
/**
|
|
4272
|
-
*
|
|
4273
|
-
* @
|
|
4312
|
+
* Ecom order ID.
|
|
4313
|
+
* @minLength 1
|
|
4314
|
+
* @maxLength 100
|
|
4274
4315
|
*/
|
|
4275
|
-
|
|
4276
|
-
|
|
4277
|
-
|
|
4278
|
-
/**
|
|
4279
|
-
|
|
4280
|
-
|
|
4281
|
-
|
|
4282
|
-
reason?: string | null;
|
|
4316
|
+
ecomOrderId: string;
|
|
4317
|
+
}
|
|
4318
|
+
interface MarkOrderAsPaidResponse {
|
|
4319
|
+
/** Updated order. */
|
|
4320
|
+
order?: Order;
|
|
4321
|
+
}
|
|
4322
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4283
4323
|
/**
|
|
4284
|
-
*
|
|
4285
|
-
* @
|
|
4324
|
+
* IDs of orders to mark as paid.
|
|
4325
|
+
* @minSize 1
|
|
4326
|
+
* @maxSize 100
|
|
4327
|
+
* @minLength 1
|
|
4328
|
+
* @maxLength 100
|
|
4286
4329
|
*/
|
|
4287
|
-
|
|
4330
|
+
ecomOrderIds: string[];
|
|
4331
|
+
}
|
|
4332
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4288
4333
|
/**
|
|
4289
|
-
*
|
|
4290
|
-
*
|
|
4334
|
+
* Items updated by the bulk action.
|
|
4335
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4291
4336
|
*/
|
|
4292
|
-
|
|
4293
|
-
/**
|
|
4294
|
-
|
|
4337
|
+
results?: BulkOrderResult[];
|
|
4338
|
+
/** Bulk action metadata. */
|
|
4339
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4295
4340
|
}
|
|
4296
|
-
interface
|
|
4341
|
+
interface BulkOrderResult {
|
|
4342
|
+
/** Item metadata. */
|
|
4343
|
+
itemMetadata?: ItemMetadata;
|
|
4297
4344
|
/**
|
|
4298
|
-
*
|
|
4299
|
-
*
|
|
4345
|
+
* Updated order.
|
|
4346
|
+
*
|
|
4347
|
+
* Returned when `returnFullEntity = true`.
|
|
4300
4348
|
*/
|
|
4301
|
-
|
|
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 {
|
|
4302
4378
|
/**
|
|
4303
|
-
*
|
|
4304
|
-
* @
|
|
4305
|
-
* @
|
|
4379
|
+
* Order ID.
|
|
4380
|
+
* @minLength 1
|
|
4381
|
+
* @maxLength 100
|
|
4306
4382
|
*/
|
|
4307
|
-
|
|
4383
|
+
ecomOrderId: string;
|
|
4308
4384
|
}
|
|
4309
|
-
interface
|
|
4385
|
+
interface GetRefundabilityStatusResponse {
|
|
4310
4386
|
/**
|
|
4311
|
-
*
|
|
4312
|
-
* @
|
|
4313
|
-
* @immutable
|
|
4387
|
+
* Refundability details.
|
|
4388
|
+
* @maxSize 300
|
|
4314
4389
|
*/
|
|
4315
|
-
|
|
4390
|
+
refundabilities?: Refundability[];
|
|
4316
4391
|
/**
|
|
4317
|
-
*
|
|
4318
|
-
* @
|
|
4319
|
-
* @max 100000
|
|
4320
|
-
* @immutable
|
|
4392
|
+
* Whether the order supports refunding per item.
|
|
4393
|
+
* @deprecated
|
|
4321
4394
|
*/
|
|
4322
|
-
|
|
4395
|
+
refundablePerItem?: boolean;
|
|
4323
4396
|
}
|
|
4324
|
-
interface
|
|
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 {
|
|
4325
4449
|
/**
|
|
4326
|
-
*
|
|
4327
|
-
* @
|
|
4328
|
-
* @
|
|
4450
|
+
* Ecom order ID.
|
|
4451
|
+
* @minLength 1
|
|
4452
|
+
* @maxLength 100
|
|
4329
4453
|
*/
|
|
4330
|
-
|
|
4454
|
+
ecomOrderId: string;
|
|
4455
|
+
/** Information about the user who initiated the payment. */
|
|
4456
|
+
chargedBy?: ChargedBy;
|
|
4457
|
+
}
|
|
4458
|
+
interface ChargedBy {
|
|
4331
4459
|
/**
|
|
4332
|
-
*
|
|
4333
|
-
* @
|
|
4460
|
+
* ID - id of the user who initiated the payment
|
|
4461
|
+
* @format GUID
|
|
4334
4462
|
*/
|
|
4335
|
-
|
|
4336
|
-
}
|
|
4337
|
-
interface ShippingRefund {
|
|
4463
|
+
id?: string;
|
|
4338
4464
|
/**
|
|
4339
|
-
*
|
|
4340
|
-
* @
|
|
4465
|
+
* Full name - name of the user who initiated the payment
|
|
4466
|
+
* @minLength 1
|
|
4467
|
+
* @maxLength 200
|
|
4341
4468
|
*/
|
|
4342
|
-
|
|
4469
|
+
fullName?: string | null;
|
|
4343
4470
|
}
|
|
4344
|
-
interface
|
|
4345
|
-
|
|
4471
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4472
|
+
/** ID of the order created in the payment gateway */
|
|
4473
|
+
paymentGatewayOrderId?: string;
|
|
4346
4474
|
}
|
|
4347
|
-
interface
|
|
4475
|
+
interface ChargeMembershipsRequest {
|
|
4348
4476
|
/**
|
|
4477
|
+
* Order ID.
|
|
4349
4478
|
* @minLength 1
|
|
4350
4479
|
* @maxLength 100
|
|
4351
4480
|
*/
|
|
4352
|
-
|
|
4481
|
+
ecomOrderId: string;
|
|
4353
4482
|
/**
|
|
4354
|
-
*
|
|
4355
|
-
*
|
|
4356
|
-
* @
|
|
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
|
|
4357
4486
|
*/
|
|
4358
|
-
|
|
4359
|
-
|
|
4360
|
-
|
|
4361
|
-
|
|
4487
|
+
memberId: string;
|
|
4488
|
+
/**
|
|
4489
|
+
* List of items to be paid by memberships
|
|
4490
|
+
* @minSize 1
|
|
4491
|
+
* @maxSize 300
|
|
4492
|
+
*/
|
|
4493
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4362
4494
|
}
|
|
4363
|
-
interface
|
|
4495
|
+
interface MembershipChargeItem {
|
|
4364
4496
|
/**
|
|
4497
|
+
* The id of used membership
|
|
4365
4498
|
* @minLength 1
|
|
4366
4499
|
* @maxLength 100
|
|
4367
4500
|
*/
|
|
4368
|
-
|
|
4501
|
+
membershipId?: string;
|
|
4369
4502
|
/**
|
|
4370
|
-
*
|
|
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
|
|
4371
4519
|
* @minLength 1
|
|
4372
|
-
* @maxLength
|
|
4520
|
+
* @maxLength 36
|
|
4373
4521
|
*/
|
|
4374
|
-
|
|
4375
|
-
/** Refund amount */
|
|
4376
|
-
refundAmount?: Price;
|
|
4522
|
+
rootCatalogItemId?: string | null;
|
|
4377
4523
|
/**
|
|
4378
|
-
*
|
|
4379
|
-
* @
|
|
4524
|
+
* line item id of Checkout/Order line item
|
|
4525
|
+
* @minLength 1
|
|
4526
|
+
* @maxLength 100
|
|
4380
4527
|
*/
|
|
4381
|
-
|
|
4528
|
+
lineItemId?: string;
|
|
4382
4529
|
}
|
|
4383
|
-
interface
|
|
4384
|
-
|
|
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;
|
|
4385
4543
|
}
|
|
4386
|
-
interface
|
|
4544
|
+
interface ChargeMembershipsResponse {
|
|
4387
4545
|
}
|
|
4388
|
-
interface
|
|
4389
|
-
emailPreview?: string;
|
|
4390
|
-
}
|
|
4391
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
4392
|
-
}
|
|
4393
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
4394
|
-
emailPreview?: string;
|
|
4395
|
-
}
|
|
4396
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4397
|
-
}
|
|
4398
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4399
|
-
emailPreview?: string;
|
|
4400
|
-
}
|
|
4401
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
4402
|
-
}
|
|
4403
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
4404
|
-
emailPreview?: string;
|
|
4405
|
-
}
|
|
4406
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
4407
|
-
}
|
|
4408
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
4409
|
-
emailPreview?: string;
|
|
4410
|
-
}
|
|
4411
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4412
|
-
/** Emitted on a meta site creation. */
|
|
4413
|
-
siteCreated?: SiteCreated;
|
|
4414
|
-
/** Emitted on a meta site transfer completion. */
|
|
4415
|
-
siteTransferred?: SiteTransferred;
|
|
4416
|
-
/** Emitted on a meta site deletion. */
|
|
4417
|
-
siteDeleted?: SiteDeleted;
|
|
4418
|
-
/** Emitted on a meta site restoration. */
|
|
4419
|
-
siteUndeleted?: SiteUndeleted;
|
|
4420
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4421
|
-
sitePublished?: SitePublished;
|
|
4422
|
-
/** Emitted on a meta site unpublish. */
|
|
4423
|
-
siteUnpublished?: SiteUnpublished;
|
|
4424
|
-
/** Emitted when meta site is marked as template. */
|
|
4425
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4426
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4427
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4428
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4429
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4430
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4431
|
-
serviceRemoved?: ServiceRemoved;
|
|
4432
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4433
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4434
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4435
|
-
hardDeleted?: SiteHardDeleted;
|
|
4436
|
-
/** Emitted on a namespace change. */
|
|
4437
|
-
namespaceChanged?: NamespaceChanged;
|
|
4438
|
-
/** Emitted when Studio is attached. */
|
|
4439
|
-
studioAssigned?: StudioAssigned;
|
|
4440
|
-
/** Emitted when Studio is detached. */
|
|
4441
|
-
studioUnassigned?: StudioUnassigned;
|
|
4546
|
+
interface TriggerRefundRequest {
|
|
4442
4547
|
/**
|
|
4443
|
-
*
|
|
4444
|
-
*
|
|
4445
|
-
*
|
|
4446
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4447
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4548
|
+
* The order this refund related to
|
|
4549
|
+
* @minLength 1
|
|
4550
|
+
* @maxLength 100
|
|
4448
4551
|
*/
|
|
4449
|
-
|
|
4450
|
-
/** Site is marked as PurgedExternally */
|
|
4451
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4452
|
-
/** Emitted when Odeditor is attached. */
|
|
4453
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4454
|
-
/** Emitted when Odeditor is detached. */
|
|
4455
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4456
|
-
/** Emitted when Picasso is attached. */
|
|
4457
|
-
picassoAssigned?: PicassoAssigned;
|
|
4458
|
-
/** Emitted when Picasso is detached. */
|
|
4459
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4460
|
-
/** Emitted when Wixel is attached. */
|
|
4461
|
-
wixelAssigned?: WixelAssigned;
|
|
4462
|
-
/** Emitted when Wixel is detached. */
|
|
4463
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4464
|
-
/** Emitted when StudioTwo is attached. */
|
|
4465
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4466
|
-
/** Emitted when StudioTwo is detached. */
|
|
4467
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4468
|
-
/** Emitted when media from user domain is enabled. */
|
|
4469
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4470
|
-
/** Emitted when media from user domain is disabled. */
|
|
4471
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4472
|
-
/** Emitted when Editorless is attached. */
|
|
4473
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4474
|
-
/** Emitted when Editorless is detached. */
|
|
4475
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4552
|
+
ecomOrderId: string;
|
|
4476
4553
|
/**
|
|
4477
|
-
*
|
|
4478
|
-
* @
|
|
4554
|
+
* Refund operations information
|
|
4555
|
+
* @minSize 1
|
|
4556
|
+
* @maxSize 1
|
|
4479
4557
|
*/
|
|
4480
|
-
|
|
4481
|
-
/**
|
|
4482
|
-
|
|
4483
|
-
/**
|
|
4484
|
-
|
|
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 {
|
|
4485
4565
|
/**
|
|
4486
|
-
*
|
|
4487
|
-
*
|
|
4488
|
-
* @maxSize 4000
|
|
4566
|
+
* Specific payment within the order to refund
|
|
4567
|
+
* @format GUID
|
|
4489
4568
|
*/
|
|
4490
|
-
|
|
4491
|
-
|
|
4492
|
-
|
|
4493
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4494
|
-
/** Emitted on a meta site creation. */
|
|
4495
|
-
siteCreated?: SiteCreated;
|
|
4496
|
-
/** Emitted on a meta site transfer completion. */
|
|
4497
|
-
siteTransferred?: SiteTransferred;
|
|
4498
|
-
/** Emitted on a meta site deletion. */
|
|
4499
|
-
siteDeleted?: SiteDeleted;
|
|
4500
|
-
/** Emitted on a meta site restoration. */
|
|
4501
|
-
siteUndeleted?: SiteUndeleted;
|
|
4502
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4503
|
-
sitePublished?: SitePublished;
|
|
4504
|
-
/** Emitted on a meta site unpublish. */
|
|
4505
|
-
siteUnpublished?: SiteUnpublished;
|
|
4506
|
-
/** Emitted when meta site is marked as template. */
|
|
4507
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4508
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
4509
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4510
|
-
/** Emitted when an application is provisioned (installed). */
|
|
4511
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
4512
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
4513
|
-
serviceRemoved?: ServiceRemoved;
|
|
4514
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
4515
|
-
siteRenamedPayload?: SiteRenamed;
|
|
4516
|
-
/** Emitted when meta site was permanently deleted. */
|
|
4517
|
-
hardDeleted?: SiteHardDeleted;
|
|
4518
|
-
/** Emitted on a namespace change. */
|
|
4519
|
-
namespaceChanged?: NamespaceChanged;
|
|
4520
|
-
/** Emitted when Studio is attached. */
|
|
4521
|
-
studioAssigned?: StudioAssigned;
|
|
4522
|
-
/** Emitted when Studio is detached. */
|
|
4523
|
-
studioUnassigned?: StudioUnassigned;
|
|
4569
|
+
paymentId?: string;
|
|
4570
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
4571
|
+
amount?: Price;
|
|
4524
4572
|
/**
|
|
4525
|
-
*
|
|
4526
|
-
* the actual
|
|
4527
|
-
*
|
|
4528
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4529
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
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.
|
|
4530
4576
|
*/
|
|
4531
|
-
|
|
4532
|
-
/** Site is marked as PurgedExternally */
|
|
4533
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
4534
|
-
/** Emitted when Odeditor is attached. */
|
|
4535
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
4536
|
-
/** Emitted when Odeditor is detached. */
|
|
4537
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
4538
|
-
/** Emitted when Picasso is attached. */
|
|
4539
|
-
picassoAssigned?: PicassoAssigned;
|
|
4540
|
-
/** Emitted when Picasso is detached. */
|
|
4541
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
4542
|
-
/** Emitted when Wixel is attached. */
|
|
4543
|
-
wixelAssigned?: WixelAssigned;
|
|
4544
|
-
/** Emitted when Wixel is detached. */
|
|
4545
|
-
wixelUnassigned?: WixelUnassigned;
|
|
4546
|
-
/** Emitted when StudioTwo is attached. */
|
|
4547
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
4548
|
-
/** Emitted when StudioTwo is detached. */
|
|
4549
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4550
|
-
/** Emitted when media from user domain is enabled. */
|
|
4551
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4552
|
-
/** Emitted when media from user domain is disabled. */
|
|
4553
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4554
|
-
/** Emitted when Editorless is attached. */
|
|
4555
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
4556
|
-
/** Emitted when Editorless is detached. */
|
|
4557
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
4577
|
+
externalRefund?: boolean;
|
|
4558
4578
|
}
|
|
4559
|
-
|
|
4579
|
+
/** Business model of a refund request */
|
|
4580
|
+
interface RefundDetails {
|
|
4560
4581
|
/**
|
|
4561
|
-
*
|
|
4562
|
-
* @
|
|
4582
|
+
* Order line item IDs and quantities that were refunded.
|
|
4583
|
+
* @maxSize 300
|
|
4563
4584
|
*/
|
|
4564
|
-
|
|
4585
|
+
items?: RefundItem[];
|
|
4586
|
+
/** Whether the shipping fee was also refunded. */
|
|
4587
|
+
shippingIncluded?: boolean;
|
|
4565
4588
|
/**
|
|
4566
|
-
*
|
|
4589
|
+
* Reason for the refund, provided by customer (optional).
|
|
4567
4590
|
* @maxLength 200
|
|
4568
4591
|
*/
|
|
4569
|
-
|
|
4570
|
-
/** An application state. */
|
|
4571
|
-
state?: StateWithLiterals;
|
|
4572
|
-
}
|
|
4573
|
-
declare enum State {
|
|
4574
|
-
UNKNOWN = "UNKNOWN",
|
|
4575
|
-
ENABLED = "ENABLED",
|
|
4576
|
-
DISABLED = "DISABLED",
|
|
4577
|
-
PENDING = "PENDING",
|
|
4578
|
-
DEMO = "DEMO"
|
|
4579
|
-
}
|
|
4580
|
-
/** @enumType */
|
|
4581
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
4582
|
-
interface SiteCreated {
|
|
4592
|
+
reason?: string | null;
|
|
4583
4593
|
/**
|
|
4584
|
-
*
|
|
4585
|
-
* @
|
|
4594
|
+
* Line items that were refunded.
|
|
4595
|
+
* @maxSize 300
|
|
4586
4596
|
*/
|
|
4587
|
-
|
|
4597
|
+
lineItems?: LineItemRefund[];
|
|
4588
4598
|
/**
|
|
4589
|
-
*
|
|
4590
|
-
* @
|
|
4599
|
+
* Additional fees that were refunded.
|
|
4600
|
+
* @maxSize 100
|
|
4591
4601
|
*/
|
|
4592
|
-
|
|
4593
|
-
/**
|
|
4594
|
-
|
|
4602
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
4603
|
+
/** Shipping amount that was refunded. */
|
|
4604
|
+
shipping?: ShippingRefund;
|
|
4605
|
+
}
|
|
4606
|
+
interface RefundItem {
|
|
4595
4607
|
/**
|
|
4596
|
-
*
|
|
4597
|
-
*
|
|
4598
|
-
* In case of a creation from a template it's a template id.
|
|
4599
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4608
|
+
* Line item ID the refunded line item.
|
|
4600
4609
|
* @format GUID
|
|
4601
4610
|
*/
|
|
4602
|
-
|
|
4611
|
+
lineItemId?: string;
|
|
4603
4612
|
/**
|
|
4604
|
-
*
|
|
4605
|
-
* @
|
|
4613
|
+
* Line item quantity refunded.
|
|
4614
|
+
* @min 1
|
|
4615
|
+
* @max 100000
|
|
4606
4616
|
*/
|
|
4607
|
-
|
|
4608
|
-
/** A namespace. */
|
|
4609
|
-
namespace?: NamespaceWithLiterals;
|
|
4610
|
-
}
|
|
4611
|
-
declare enum SiteCreatedContext {
|
|
4612
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4613
|
-
OTHER = "OTHER",
|
|
4614
|
-
/** A meta site was created from template. */
|
|
4615
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4616
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
4617
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4618
|
-
/** A copy of existing meta site. */
|
|
4619
|
-
DUPLICATE = "DUPLICATE",
|
|
4620
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4621
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4622
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
4623
|
-
FLASH = "FLASH"
|
|
4617
|
+
quantity?: number;
|
|
4624
4618
|
}
|
|
4625
|
-
|
|
4626
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4627
|
-
declare enum Namespace {
|
|
4628
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4629
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4630
|
-
WIX = "WIX",
|
|
4631
|
-
/** 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. */
|
|
4632
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
4633
|
-
/** 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. */
|
|
4634
|
-
ALBUMS = "ALBUMS",
|
|
4635
|
-
/** 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. */
|
|
4636
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4637
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4638
|
-
HOTELS = "HOTELS",
|
|
4639
|
-
/** 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. */
|
|
4640
|
-
CLUBS = "CLUBS",
|
|
4641
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4642
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4619
|
+
interface LineItemRefund {
|
|
4643
4620
|
/**
|
|
4644
|
-
*
|
|
4645
|
-
*
|
|
4621
|
+
* Line item ID.
|
|
4622
|
+
* @format GUID
|
|
4623
|
+
* @immutable
|
|
4646
4624
|
*/
|
|
4647
|
-
|
|
4648
|
-
/** 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. */
|
|
4649
|
-
LOGOS = "LOGOS",
|
|
4650
|
-
/** 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. */
|
|
4651
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4652
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4653
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4654
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4655
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4625
|
+
lineItemId?: string;
|
|
4656
4626
|
/**
|
|
4657
|
-
*
|
|
4658
|
-
*
|
|
4659
|
-
*
|
|
4627
|
+
* Refund quantity.
|
|
4628
|
+
* @min 1
|
|
4629
|
+
* @max 100000
|
|
4630
|
+
* @immutable
|
|
4660
4631
|
*/
|
|
4661
|
-
|
|
4632
|
+
quantity?: number;
|
|
4633
|
+
}
|
|
4634
|
+
interface AdditionalFeeRefund {
|
|
4662
4635
|
/**
|
|
4663
|
-
*
|
|
4664
|
-
*
|
|
4665
|
-
*
|
|
4666
|
-
*/
|
|
4667
|
-
|
|
4668
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4669
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4670
|
-
/** It is to be used in the Business First efforts. */
|
|
4671
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4672
|
-
/** Bookings business flow with no site. */
|
|
4673
|
-
ANYWHERE = "ANYWHERE",
|
|
4674
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
4675
|
-
HEADLESS = "HEADLESS",
|
|
4636
|
+
* Additional fee ID.
|
|
4637
|
+
* @format GUID
|
|
4638
|
+
* @immutable
|
|
4639
|
+
*/
|
|
4640
|
+
additionalFeeId?: string;
|
|
4676
4641
|
/**
|
|
4677
|
-
*
|
|
4678
|
-
*
|
|
4642
|
+
* Refund amount.
|
|
4643
|
+
* @immutable
|
|
4679
4644
|
*/
|
|
4680
|
-
|
|
4681
|
-
|
|
4682
|
-
|
|
4645
|
+
amount?: Price;
|
|
4646
|
+
}
|
|
4647
|
+
interface ShippingRefund {
|
|
4683
4648
|
/**
|
|
4684
|
-
*
|
|
4685
|
-
*
|
|
4686
|
-
* The Mobile company will be the owner of this namespace.
|
|
4649
|
+
* Refund amount.
|
|
4650
|
+
* @immutable
|
|
4687
4651
|
*/
|
|
4688
|
-
|
|
4689
|
-
|
|
4690
|
-
|
|
4652
|
+
amount?: Price;
|
|
4653
|
+
}
|
|
4654
|
+
interface RefundSideEffects {
|
|
4655
|
+
/** Inventory restock details as part of this refund. */
|
|
4656
|
+
restockInfo?: RestockInfo;
|
|
4657
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
4658
|
+
sendOrderRefundedEmail?: boolean;
|
|
4691
4659
|
/**
|
|
4692
|
-
*
|
|
4693
|
-
*
|
|
4660
|
+
* Custom message added to the refund confirmation email.
|
|
4661
|
+
* @minLength 1
|
|
4662
|
+
* @maxLength 1000
|
|
4694
4663
|
*/
|
|
4695
|
-
|
|
4696
|
-
|
|
4697
|
-
|
|
4698
|
-
/**
|
|
4699
|
-
|
|
4664
|
+
customMessage?: string | null;
|
|
4665
|
+
}
|
|
4666
|
+
interface RestockInfo {
|
|
4667
|
+
/** Restock type. */
|
|
4668
|
+
type?: RestockTypeWithLiterals;
|
|
4700
4669
|
/**
|
|
4701
|
-
*
|
|
4702
|
-
*
|
|
4670
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
4671
|
+
* @maxSize 300
|
|
4703
4672
|
*/
|
|
4704
|
-
|
|
4705
|
-
|
|
4706
|
-
|
|
4707
|
-
|
|
4708
|
-
|
|
4709
|
-
|
|
4710
|
-
|
|
4711
|
-
|
|
4712
|
-
|
|
4713
|
-
|
|
4714
|
-
NANO = "NANO",
|
|
4715
|
-
/** Base44 headless sites. */
|
|
4716
|
-
BASE44 = "BASE44",
|
|
4717
|
-
/** Wix Channels Sites */
|
|
4718
|
-
CHANNELS = "CHANNELS",
|
|
4719
|
-
/** Nautilus platform. */
|
|
4720
|
-
NAUTILUS = "NAUTILUS",
|
|
4673
|
+
items?: RestockItem[];
|
|
4674
|
+
}
|
|
4675
|
+
declare enum RestockType {
|
|
4676
|
+
NO_ITEMS = "NO_ITEMS",
|
|
4677
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
4678
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
4679
|
+
}
|
|
4680
|
+
/** @enumType */
|
|
4681
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
4682
|
+
interface RestockItem {
|
|
4721
4683
|
/**
|
|
4722
|
-
*
|
|
4723
|
-
*
|
|
4684
|
+
* ID of the line item being restocked.
|
|
4685
|
+
* @format GUID
|
|
4724
4686
|
*/
|
|
4725
|
-
|
|
4726
|
-
/** Nautilus platform app. */
|
|
4727
|
-
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
4687
|
+
lineItemId?: string;
|
|
4728
4688
|
/**
|
|
4729
|
-
*
|
|
4730
|
-
*
|
|
4689
|
+
* Line item quantity being restocked.
|
|
4690
|
+
* @min 1
|
|
4691
|
+
* @max 100000
|
|
4731
4692
|
*/
|
|
4732
|
-
|
|
4693
|
+
quantity?: number;
|
|
4694
|
+
}
|
|
4695
|
+
interface TriggerRefundResponse {
|
|
4696
|
+
/** All order's transactions after the refunds were added */
|
|
4697
|
+
orderTransactions?: OrderTransactions;
|
|
4698
|
+
/** Created refund ID */
|
|
4699
|
+
refundId?: string | null;
|
|
4700
|
+
/** Payment ID's that the refund execution had failed for */
|
|
4701
|
+
failedPaymentIds?: ItemMetadata[];
|
|
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 {
|
|
4733
4709
|
/**
|
|
4734
|
-
*
|
|
4735
|
-
*
|
|
4736
|
-
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
4737
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
4710
|
+
* Order ID.
|
|
4711
|
+
* @format GUID
|
|
4738
4712
|
*/
|
|
4739
|
-
|
|
4713
|
+
orderId?: string;
|
|
4740
4714
|
/**
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4715
|
+
* Record of payments made to the merchant.
|
|
4716
|
+
* @maxSize 100
|
|
4743
4717
|
*/
|
|
4744
|
-
|
|
4718
|
+
payments?: Payment[];
|
|
4719
|
+
/**
|
|
4720
|
+
* Record of refunds made to the buyer.
|
|
4721
|
+
* @maxSize 300
|
|
4722
|
+
*/
|
|
4723
|
+
refunds?: Refund[];
|
|
4745
4724
|
}
|
|
4746
|
-
|
|
4747
|
-
|
|
4748
|
-
|
|
4749
|
-
|
|
4725
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
4726
|
+
/** Regular payment details. */
|
|
4727
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
4728
|
+
/** Gift card payment details. */
|
|
4729
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4730
|
+
/** Membership payment details. */
|
|
4731
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4750
4732
|
/**
|
|
4751
|
-
*
|
|
4733
|
+
* Payment ID.
|
|
4752
4734
|
* @format GUID
|
|
4735
|
+
* @readonly
|
|
4753
4736
|
*/
|
|
4754
|
-
|
|
4737
|
+
id?: string | null;
|
|
4738
|
+
/** 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. */
|
|
4739
|
+
createdDate?: Date | null;
|
|
4755
4740
|
/**
|
|
4756
|
-
*
|
|
4757
|
-
* @
|
|
4741
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
4742
|
+
* @readonly
|
|
4758
4743
|
*/
|
|
4759
|
-
|
|
4760
|
-
|
|
4761
|
-
|
|
4762
|
-
interface SiteDeleted {
|
|
4763
|
-
/** A deletion context. */
|
|
4764
|
-
deleteContext?: DeleteContext;
|
|
4765
|
-
}
|
|
4766
|
-
interface DeleteContext {
|
|
4767
|
-
/** When the meta site was deleted. */
|
|
4768
|
-
dateDeleted?: Date | null;
|
|
4769
|
-
/** A status. */
|
|
4770
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
4744
|
+
updatedDate?: Date | null;
|
|
4745
|
+
/** Payment amount. */
|
|
4746
|
+
amount?: Price;
|
|
4771
4747
|
/**
|
|
4772
|
-
*
|
|
4773
|
-
*
|
|
4748
|
+
* Whether refunds for this payment are disabled.
|
|
4749
|
+
* + `true`: This payment is not refundable.
|
|
4750
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
4774
4751
|
*/
|
|
4775
|
-
|
|
4752
|
+
refundDisabled?: boolean;
|
|
4776
4753
|
/**
|
|
4777
|
-
*
|
|
4778
|
-
*
|
|
4754
|
+
* Whether receipt generation is allowed for this payment.
|
|
4755
|
+
* + `true`: This payment supports receipt generation.
|
|
4756
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
4757
|
+
* @readonly
|
|
4779
4758
|
*/
|
|
4780
|
-
|
|
4759
|
+
supportReceiptGeneration?: boolean;
|
|
4760
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
4761
|
+
cashRounding?: CashRoundingDetails;
|
|
4762
|
+
/**
|
|
4763
|
+
* Overall payment status.
|
|
4764
|
+
*
|
|
4765
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
4766
|
+
*/
|
|
4767
|
+
status?: PaymentStatusWithLiterals;
|
|
4768
|
+
/**
|
|
4769
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
4770
|
+
* @format GUID
|
|
4771
|
+
*/
|
|
4772
|
+
chargeCorrelationId?: string | null;
|
|
4781
4773
|
}
|
|
4782
|
-
|
|
4783
|
-
|
|
4784
|
-
|
|
4785
|
-
|
|
4786
|
-
|
|
4787
|
-
|
|
4774
|
+
/** @oneof */
|
|
4775
|
+
interface PaymentPaymentDetailsOneOf {
|
|
4776
|
+
/** Regular payment details. */
|
|
4777
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
4778
|
+
/** Gift card payment details. */
|
|
4779
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4780
|
+
/** Membership payment details. */
|
|
4781
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
4788
4782
|
}
|
|
4789
|
-
/** @
|
|
4790
|
-
|
|
4791
|
-
/** Restoration of the meta site. */
|
|
4792
|
-
interface SiteUndeleted {
|
|
4783
|
+
/** @oneof */
|
|
4784
|
+
interface PaymentReceiptInfoOneOf {
|
|
4793
4785
|
}
|
|
4794
|
-
/**
|
|
4795
|
-
interface
|
|
4786
|
+
/** @oneof */
|
|
4787
|
+
interface PaymentStatusDetailsOneOf {
|
|
4796
4788
|
}
|
|
4797
|
-
interface
|
|
4789
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
4790
|
+
/** Credit card details. */
|
|
4791
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4798
4792
|
/**
|
|
4799
|
-
*
|
|
4800
|
-
* @maxLength
|
|
4801
|
-
* @maxSize 10000
|
|
4793
|
+
* Wix Payments order ID.
|
|
4794
|
+
* @maxLength 100
|
|
4802
4795
|
*/
|
|
4803
|
-
|
|
4804
|
-
}
|
|
4805
|
-
interface SiteMarkedAsTemplate {
|
|
4806
|
-
}
|
|
4807
|
-
interface SiteMarkedAsWixSite {
|
|
4808
|
-
}
|
|
4809
|
-
/**
|
|
4810
|
-
* Represents a service provisioned a site.
|
|
4811
|
-
*
|
|
4812
|
-
* Note on `origin_instance_id`:
|
|
4813
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
4814
|
-
* This is because of the following scenario:
|
|
4815
|
-
*
|
|
4816
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
4817
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
4818
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
4819
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
4820
|
-
* your site remains consistent with what you initially received and does not include any
|
|
4821
|
-
* changes made to the original template afterward.
|
|
4822
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
4823
|
-
*/
|
|
4824
|
-
interface ServiceProvisioned {
|
|
4796
|
+
paymentOrderId?: string | null;
|
|
4825
4797
|
/**
|
|
4826
|
-
*
|
|
4827
|
-
*
|
|
4798
|
+
* Payment gateway's transaction ID.
|
|
4799
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
4800
|
+
* @maxLength 100
|
|
4801
|
+
*/
|
|
4802
|
+
gatewayTransactionId?: string | null;
|
|
4803
|
+
/**
|
|
4804
|
+
* Payment method.
|
|
4805
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
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
|
|
4828
4815
|
*/
|
|
4829
|
-
|
|
4816
|
+
paymentMethod?: string | null;
|
|
4830
4817
|
/**
|
|
4831
|
-
*
|
|
4832
|
-
* @maxLength
|
|
4818
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
4819
|
+
* @maxLength 100
|
|
4833
4820
|
*/
|
|
4834
|
-
|
|
4821
|
+
providerTransactionId?: string | null;
|
|
4822
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
4823
|
+
offlinePayment?: boolean;
|
|
4835
4824
|
/**
|
|
4836
|
-
*
|
|
4837
|
-
* @
|
|
4825
|
+
* Payment status.
|
|
4826
|
+
* @deprecated Payment status.
|
|
4827
|
+
* @replacedBy payment.status
|
|
4828
|
+
* @targetRemovalDate 2026-11-01
|
|
4838
4829
|
*/
|
|
4839
|
-
|
|
4830
|
+
status?: TransactionStatusWithLiterals;
|
|
4831
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
4832
|
+
savedPaymentMethod?: boolean;
|
|
4833
|
+
/** Authorization details. */
|
|
4834
|
+
authorizationDetails?: AuthorizationDetails;
|
|
4840
4835
|
/**
|
|
4841
|
-
*
|
|
4842
|
-
* @
|
|
4836
|
+
* Record of chargebacks made by the buyer.
|
|
4837
|
+
* @maxSize 6
|
|
4843
4838
|
*/
|
|
4844
|
-
|
|
4839
|
+
chargebacks?: Chargeback[];
|
|
4840
|
+
/** Platform fee amount associated with this payment. */
|
|
4841
|
+
platformFee?: Price;
|
|
4845
4842
|
/**
|
|
4846
|
-
*
|
|
4847
|
-
*
|
|
4843
|
+
* Payment method with buyer and optional owner translations.
|
|
4844
|
+
* Non-exhaustive list of supported values:
|
|
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`
|
|
4848
4846
|
*/
|
|
4849
|
-
|
|
4847
|
+
paymentMethodName?: PaymentMethodName;
|
|
4850
4848
|
}
|
|
4851
|
-
|
|
4852
|
-
|
|
4853
|
-
|
|
4854
|
-
|
|
4855
|
-
|
|
4856
|
-
|
|
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 {
|
|
4857
4869
|
/**
|
|
4858
|
-
*
|
|
4859
|
-
* @maxLength
|
|
4870
|
+
* The last 4 digits of the card number.
|
|
4871
|
+
* @maxLength 4
|
|
4860
4872
|
*/
|
|
4861
|
-
|
|
4873
|
+
lastFourDigits?: string | null;
|
|
4862
4874
|
/**
|
|
4863
|
-
*
|
|
4864
|
-
* @maxLength
|
|
4875
|
+
* Card issuer's brand.
|
|
4876
|
+
* @maxLength 100
|
|
4865
4877
|
*/
|
|
4866
|
-
|
|
4878
|
+
brand?: string | null;
|
|
4867
4879
|
}
|
|
4868
|
-
|
|
4869
|
-
interface SiteRenamed {
|
|
4880
|
+
interface AuthorizationDetails {
|
|
4870
4881
|
/**
|
|
4871
|
-
*
|
|
4872
|
-
* @
|
|
4882
|
+
* Whether the authorized payment is of a delayed capture.
|
|
4883
|
+
* @readonly
|
|
4873
4884
|
*/
|
|
4874
|
-
|
|
4885
|
+
delayedCapture?: boolean;
|
|
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;
|
|
4875
4888
|
/**
|
|
4876
|
-
*
|
|
4877
|
-
*
|
|
4889
|
+
* List of captures associated with payment
|
|
4890
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
4891
|
+
* @maxSize 1
|
|
4878
4892
|
*/
|
|
4879
|
-
|
|
4880
|
-
|
|
4881
|
-
|
|
4882
|
-
|
|
4883
|
-
|
|
4884
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
4885
|
-
*/
|
|
4886
|
-
interface SiteHardDeleted {
|
|
4887
|
-
/** A deletion context. */
|
|
4888
|
-
deleteContext?: DeleteContext;
|
|
4889
|
-
}
|
|
4890
|
-
interface NamespaceChanged {
|
|
4891
|
-
/** A previous namespace. */
|
|
4892
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
4893
|
-
/** A new namespace. */
|
|
4894
|
-
newNamespace?: NamespaceWithLiterals;
|
|
4895
|
-
}
|
|
4896
|
-
/** Assigned Studio editor */
|
|
4897
|
-
interface StudioAssigned {
|
|
4898
|
-
}
|
|
4899
|
-
/** Unassigned Studio editor */
|
|
4900
|
-
interface StudioUnassigned {
|
|
4901
|
-
}
|
|
4902
|
-
/**
|
|
4903
|
-
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4904
|
-
*
|
|
4905
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4906
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4907
|
-
*
|
|
4908
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4909
|
-
*/
|
|
4910
|
-
interface SiteUrlChanged {
|
|
4893
|
+
captures?: AuthorizationCapture[];
|
|
4894
|
+
/** Void associated with payment */
|
|
4895
|
+
void?: AuthorizationVoid;
|
|
4896
|
+
/** Scheduled action for this transaction */
|
|
4897
|
+
scheduledAction?: V1ScheduledAction;
|
|
4911
4898
|
}
|
|
4912
|
-
|
|
4913
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4914
|
-
* Consumed by other teams to remove relevant data.
|
|
4915
|
-
*/
|
|
4916
|
-
interface SitePurgedExternally {
|
|
4899
|
+
interface AuthorizationCapture {
|
|
4917
4900
|
/**
|
|
4918
|
-
*
|
|
4919
|
-
* @
|
|
4920
|
-
* @
|
|
4921
|
-
* @targetRemovalDate 2025-04-15
|
|
4901
|
+
* Capture ID.
|
|
4902
|
+
* @format GUID
|
|
4903
|
+
* @readonly
|
|
4922
4904
|
*/
|
|
4923
|
-
|
|
4924
|
-
|
|
4925
|
-
|
|
4926
|
-
|
|
4927
|
-
|
|
4928
|
-
|
|
4929
|
-
|
|
4930
|
-
|
|
4931
|
-
/**
|
|
4932
|
-
|
|
4933
|
-
|
|
4934
|
-
|
|
4935
|
-
interface PicassoUnassigned {
|
|
4936
|
-
}
|
|
4937
|
-
/** Assigned Wixel */
|
|
4938
|
-
interface WixelAssigned {
|
|
4939
|
-
}
|
|
4940
|
-
/** Unassigned Wixel */
|
|
4941
|
-
interface WixelUnassigned {
|
|
4942
|
-
}
|
|
4943
|
-
/** Assigned StudioTwo */
|
|
4944
|
-
interface StudioTwoAssigned {
|
|
4945
|
-
}
|
|
4946
|
-
/** Unassigned StudioTwo */
|
|
4947
|
-
interface StudioTwoUnassigned {
|
|
4948
|
-
}
|
|
4949
|
-
/** Media from user domain is enabled. */
|
|
4950
|
-
interface UserDomainMediaEnabled {
|
|
4951
|
-
}
|
|
4952
|
-
/** Media from user domain is disabled. */
|
|
4953
|
-
interface UserDomainMediaDisabled {
|
|
4954
|
-
}
|
|
4955
|
-
/** Assigned Editorless */
|
|
4956
|
-
interface EditorlessAssigned {
|
|
4957
|
-
}
|
|
4958
|
-
/** Unassigned Editorless */
|
|
4959
|
-
interface EditorlessUnassigned {
|
|
4905
|
+
id?: string | null;
|
|
4906
|
+
/** Status of this capture action */
|
|
4907
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
4908
|
+
/**
|
|
4909
|
+
* Amount of this capture
|
|
4910
|
+
* @immutable
|
|
4911
|
+
*/
|
|
4912
|
+
amount?: Price;
|
|
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;
|
|
4960
4917
|
}
|
|
4961
|
-
|
|
4918
|
+
declare enum AuthorizationCaptureStatus {
|
|
4919
|
+
/** Capture operation still in progress. */
|
|
4920
|
+
PENDING = "PENDING",
|
|
4921
|
+
/** Capture operation succeeded. */
|
|
4922
|
+
SUCCEEDED = "SUCCEEDED",
|
|
4923
|
+
/** Capture operation failed. */
|
|
4924
|
+
FAILED = "FAILED"
|
|
4962
4925
|
}
|
|
4963
|
-
|
|
4964
|
-
|
|
4926
|
+
/** @enumType */
|
|
4927
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4928
|
+
interface AuthorizationActionFailureDetails {
|
|
4929
|
+
/** @maxLength 100 */
|
|
4930
|
+
failureCode?: string;
|
|
4965
4931
|
}
|
|
4966
|
-
interface
|
|
4967
|
-
/**
|
|
4968
|
-
|
|
4969
|
-
/**
|
|
4970
|
-
|
|
4932
|
+
interface AuthorizationVoid {
|
|
4933
|
+
/** Status of this void action */
|
|
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;
|
|
4971
4941
|
}
|
|
4972
|
-
declare enum
|
|
4973
|
-
|
|
4974
|
-
|
|
4942
|
+
declare enum AuthorizationVoidStatus {
|
|
4943
|
+
/** Void operation still in progress. */
|
|
4944
|
+
PENDING = "PENDING",
|
|
4945
|
+
/** Void operation succeeded. */
|
|
4946
|
+
SUCCEEDED = "SUCCEEDED",
|
|
4947
|
+
/** Void operation failed. */
|
|
4948
|
+
FAILED = "FAILED"
|
|
4975
4949
|
}
|
|
4976
4950
|
/** @enumType */
|
|
4977
|
-
type
|
|
4978
|
-
|
|
4979
|
-
|
|
4951
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4952
|
+
/** Reason the authorization was voided. */
|
|
4953
|
+
declare enum Reason {
|
|
4954
|
+
/** Authorization was voided by user. */
|
|
4955
|
+
MANUAL = "MANUAL",
|
|
4956
|
+
/** Authorization passed execution date. */
|
|
4957
|
+
SCHEDULED = "SCHEDULED"
|
|
4980
4958
|
}
|
|
4981
|
-
|
|
4959
|
+
/** @enumType */
|
|
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;
|
|
4982
4966
|
}
|
|
4983
|
-
|
|
4984
|
-
|
|
4967
|
+
declare enum ActionType {
|
|
4968
|
+
VOID = "VOID",
|
|
4969
|
+
CAPTURE = "CAPTURE"
|
|
4985
4970
|
}
|
|
4986
|
-
|
|
4987
|
-
|
|
4988
|
-
|
|
4989
|
-
* @minLength 1
|
|
4990
|
-
* @maxLength 100
|
|
4991
|
-
*/
|
|
4992
|
-
ecomOrderId: string;
|
|
4993
|
-
/** Amount to collect */
|
|
4994
|
-
amount: Price;
|
|
4995
|
-
/**
|
|
4996
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4997
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
4998
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4999
|
-
*/
|
|
5000
|
-
paymentGatewayOrderId?: string | null;
|
|
4971
|
+
/** @enumType */
|
|
4972
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
4973
|
+
interface Chargeback {
|
|
5001
4974
|
/**
|
|
5002
|
-
*
|
|
5003
|
-
*
|
|
5004
|
-
* @
|
|
5005
|
-
*
|
|
5006
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
5007
|
-
* @targetRemovalDate 2024-09-30
|
|
4975
|
+
* Chargeback ID.
|
|
4976
|
+
* @format GUID
|
|
4977
|
+
* @readonly
|
|
4978
|
+
* @immutable
|
|
5008
4979
|
*/
|
|
5009
|
-
|
|
5010
|
-
/** Delayed capture payment settings */
|
|
5011
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
5012
|
-
}
|
|
5013
|
-
interface RedirectUrls {
|
|
4980
|
+
id?: string;
|
|
5014
4981
|
/**
|
|
5015
|
-
*
|
|
5016
|
-
* @
|
|
4982
|
+
* 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.
|
|
4983
|
+
* @readonly
|
|
4984
|
+
* @immutable
|
|
5017
4985
|
*/
|
|
5018
|
-
|
|
4986
|
+
createdDate?: Date | null;
|
|
5019
4987
|
/**
|
|
5020
|
-
*
|
|
5021
|
-
* @
|
|
4988
|
+
* 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.
|
|
4989
|
+
* @readonly
|
|
5022
4990
|
*/
|
|
5023
|
-
|
|
4991
|
+
updatedDate?: Date | null;
|
|
5024
4992
|
/**
|
|
5025
|
-
*
|
|
5026
|
-
* @
|
|
4993
|
+
* Amount.
|
|
4994
|
+
* @readonly
|
|
4995
|
+
* @immutable
|
|
5027
4996
|
*/
|
|
5028
|
-
|
|
4997
|
+
amount?: Price;
|
|
5029
4998
|
/**
|
|
5030
|
-
*
|
|
5031
|
-
* @
|
|
4999
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5000
|
+
* @readonly
|
|
5032
5001
|
*/
|
|
5033
|
-
|
|
5034
|
-
}
|
|
5035
|
-
interface DelayedCaptureSettings {
|
|
5036
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
5037
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
5038
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
5039
|
-
delayDuration?: Duration;
|
|
5040
|
-
}
|
|
5041
|
-
declare enum ScheduledAction {
|
|
5042
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
5043
|
-
VOID = "VOID",
|
|
5044
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
5045
|
-
CAPTURE = "CAPTURE"
|
|
5046
|
-
}
|
|
5047
|
-
/** @enumType */
|
|
5048
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
5049
|
-
interface Duration {
|
|
5002
|
+
reversalAmount?: Price;
|
|
5050
5003
|
/**
|
|
5051
|
-
*
|
|
5052
|
-
*
|
|
5004
|
+
* Status.
|
|
5005
|
+
*
|
|
5006
|
+
* Default: `"APPROVED"`.
|
|
5053
5007
|
*/
|
|
5054
|
-
|
|
5055
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
5056
|
-
unit?: DurationUnitWithLiterals;
|
|
5057
|
-
}
|
|
5058
|
-
declare enum DurationUnit {
|
|
5059
|
-
MINUTES = "MINUTES",
|
|
5060
|
-
HOURS = "HOURS",
|
|
5061
|
-
DAYS = "DAYS"
|
|
5062
|
-
}
|
|
5063
|
-
/** @enumType */
|
|
5064
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
5065
|
-
interface PreparePaymentCollectionResponse {
|
|
5066
|
-
/** Payment gateway order id which is associated with given payment */
|
|
5067
|
-
paymentGatewayOrderId?: string;
|
|
5068
|
-
}
|
|
5069
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
5008
|
+
status?: ChargebackStatusWithLiterals;
|
|
5070
5009
|
/**
|
|
5071
|
-
*
|
|
5072
|
-
* @
|
|
5073
|
-
* @
|
|
5010
|
+
* External chargeback ID.
|
|
5011
|
+
* @format GUID
|
|
5012
|
+
* @readonly
|
|
5013
|
+
* @immutable
|
|
5074
5014
|
*/
|
|
5075
|
-
|
|
5076
|
-
}
|
|
5077
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
5078
|
-
/** Payment collectability status */
|
|
5079
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
5080
|
-
/** Collectable order amount */
|
|
5081
|
-
amount?: Price;
|
|
5015
|
+
externalId?: string | null;
|
|
5082
5016
|
}
|
|
5083
|
-
declare enum
|
|
5084
|
-
|
|
5085
|
-
|
|
5086
|
-
|
|
5087
|
-
|
|
5088
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
5089
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
5090
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
5091
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
5092
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
5093
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
5094
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
5095
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
5096
|
-
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
5017
|
+
declare enum ChargebackStatus {
|
|
5018
|
+
/** Chargeback was approved. */
|
|
5019
|
+
APPROVED = "APPROVED",
|
|
5020
|
+
/** Chargeback was reversed. */
|
|
5021
|
+
REVERSED = "REVERSED"
|
|
5097
5022
|
}
|
|
5098
5023
|
/** @enumType */
|
|
5099
|
-
type
|
|
5100
|
-
interface
|
|
5101
|
-
/**
|
|
5102
|
-
* Order ID.
|
|
5103
|
-
* @minLength 1
|
|
5104
|
-
* @maxLength 100
|
|
5105
|
-
*/
|
|
5106
|
-
orderId: string;
|
|
5107
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
5108
|
-
amount: Price;
|
|
5109
|
-
}
|
|
5110
|
-
/**
|
|
5111
|
-
* User-defined payment method name.
|
|
5112
|
-
* Allows specifying either a predefined type or a custom name.
|
|
5113
|
-
*/
|
|
5114
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
5115
|
-
/** Predefined payment method. */
|
|
5116
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5024
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5025
|
+
interface PaymentMethodName {
|
|
5117
5026
|
/**
|
|
5118
|
-
*
|
|
5119
|
-
*
|
|
5120
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5121
|
-
* @minLength 1
|
|
5027
|
+
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
5122
5028
|
* @maxLength 150
|
|
5123
5029
|
*/
|
|
5124
|
-
|
|
5125
|
-
}
|
|
5126
|
-
/** @oneof */
|
|
5127
|
-
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
5128
|
-
/** Predefined payment method. */
|
|
5129
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5030
|
+
buyerLanguageName?: string | null;
|
|
5130
5031
|
/**
|
|
5131
|
-
*
|
|
5032
|
+
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
5132
5033
|
*
|
|
5133
|
-
*
|
|
5134
|
-
* @minLength 1
|
|
5034
|
+
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
5135
5035
|
* @maxLength 150
|
|
5136
5036
|
*/
|
|
5137
|
-
|
|
5138
|
-
}
|
|
5139
|
-
/** Predefined payment method types for offline/manual payments. */
|
|
5140
|
-
declare enum PredefinedPaymentMethod {
|
|
5141
|
-
/** Cash payment. */
|
|
5142
|
-
CASH = "CASH",
|
|
5143
|
-
/** Bank transfer. */
|
|
5144
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
5145
|
-
/** Payment by check. */
|
|
5146
|
-
CHECK = "CHECK"
|
|
5147
|
-
}
|
|
5148
|
-
/** @enumType */
|
|
5149
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
5150
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
5151
|
-
}
|
|
5152
|
-
interface MarkOrderAsPaidRequest {
|
|
5037
|
+
siteLanguageName?: string | null;
|
|
5153
5038
|
/**
|
|
5154
|
-
*
|
|
5155
|
-
*
|
|
5156
|
-
*
|
|
5039
|
+
* User-provided payment method name.
|
|
5040
|
+
*
|
|
5041
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5157
5042
|
*/
|
|
5158
|
-
|
|
5159
|
-
}
|
|
5160
|
-
interface MarkOrderAsPaidResponse {
|
|
5161
|
-
/** Updated order. */
|
|
5162
|
-
order?: Order;
|
|
5043
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5163
5044
|
}
|
|
5164
|
-
interface
|
|
5045
|
+
interface GiftCardPaymentDetails {
|
|
5165
5046
|
/**
|
|
5166
|
-
*
|
|
5167
|
-
* @minSize 1
|
|
5168
|
-
* @maxSize 100
|
|
5169
|
-
* @minLength 1
|
|
5047
|
+
* Gift card payment ID.
|
|
5170
5048
|
* @maxLength 100
|
|
5171
5049
|
*/
|
|
5172
|
-
|
|
5173
|
-
}
|
|
5174
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
5050
|
+
giftCardPaymentId?: string;
|
|
5175
5051
|
/**
|
|
5176
|
-
*
|
|
5177
|
-
*
|
|
5052
|
+
* ID of the app that created the gift card.
|
|
5053
|
+
* @format GUID
|
|
5178
5054
|
*/
|
|
5179
|
-
|
|
5180
|
-
/** Bulk action metadata. */
|
|
5181
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
5182
|
-
}
|
|
5183
|
-
interface BulkOrderResult {
|
|
5184
|
-
/** Item metadata. */
|
|
5185
|
-
itemMetadata?: ItemMetadata;
|
|
5055
|
+
appId?: string;
|
|
5186
5056
|
/**
|
|
5187
|
-
*
|
|
5188
|
-
*
|
|
5189
|
-
*
|
|
5190
|
-
|
|
5191
|
-
|
|
5192
|
-
|
|
5193
|
-
|
|
5194
|
-
/**
|
|
5195
|
-
|
|
5196
|
-
|
|
5197
|
-
|
|
5198
|
-
|
|
5199
|
-
|
|
5200
|
-
/** Details about the error in case of failure. */
|
|
5201
|
-
error?: ApplicationError;
|
|
5202
|
-
}
|
|
5203
|
-
interface ApplicationError {
|
|
5204
|
-
/** Error code. */
|
|
5205
|
-
code?: string;
|
|
5206
|
-
/** Description of the error. */
|
|
5207
|
-
description?: string;
|
|
5208
|
-
/** Data related to the error. */
|
|
5209
|
-
data?: Record<string, any> | null;
|
|
5210
|
-
}
|
|
5211
|
-
interface BulkActionMetadata {
|
|
5212
|
-
/** Number of items that were successfully processed. */
|
|
5213
|
-
totalSuccesses?: number;
|
|
5214
|
-
/** Number of items that couldn't be processed. */
|
|
5215
|
-
totalFailures?: number;
|
|
5216
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5217
|
-
undetailedFailures?: number;
|
|
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;
|
|
5218
5070
|
}
|
|
5219
|
-
interface
|
|
5071
|
+
interface MembershipPaymentDetails {
|
|
5220
5072
|
/**
|
|
5221
|
-
*
|
|
5073
|
+
* Membership ID.
|
|
5074
|
+
* @maxLength 200
|
|
5075
|
+
*/
|
|
5076
|
+
membershipId?: string;
|
|
5077
|
+
/**
|
|
5078
|
+
* ID of the line item this membership applies to.
|
|
5222
5079
|
* @minLength 1
|
|
5223
5080
|
* @maxLength 100
|
|
5224
5081
|
*/
|
|
5225
|
-
|
|
5226
|
-
}
|
|
5227
|
-
interface GetRefundabilityStatusResponse {
|
|
5082
|
+
lineItemId?: string;
|
|
5228
5083
|
/**
|
|
5229
|
-
*
|
|
5230
|
-
* @
|
|
5084
|
+
* Payment status.
|
|
5085
|
+
* @deprecated Payment status.
|
|
5086
|
+
* @replacedBy payment.status
|
|
5087
|
+
* @targetRemovalDate 2026-11-01
|
|
5231
5088
|
*/
|
|
5232
|
-
|
|
5089
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5090
|
+
/** Membership name. */
|
|
5091
|
+
name?: MembershipName;
|
|
5233
5092
|
/**
|
|
5234
|
-
*
|
|
5235
|
-
* @
|
|
5093
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5094
|
+
* @minLength 1
|
|
5095
|
+
* @maxLength 100
|
|
5236
5096
|
*/
|
|
5237
|
-
|
|
5238
|
-
|
|
5239
|
-
|
|
5240
|
-
|
|
5241
|
-
|
|
5242
|
-
|
|
5243
|
-
|
|
5244
|
-
|
|
5245
|
-
|
|
5246
|
-
/**
|
|
5247
|
-
|
|
5248
|
-
|
|
5249
|
-
|
|
5250
|
-
|
|
5251
|
-
/**
|
|
5252
|
-
|
|
5253
|
-
/** Reason why payment is not refundable. */
|
|
5254
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5255
|
-
/** Reason why payment is only refundable manually. */
|
|
5256
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5257
|
-
}
|
|
5258
|
-
declare enum RefundableStatus {
|
|
5259
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
5260
|
-
MANUAL = "MANUAL",
|
|
5261
|
-
REFUNDABLE = "REFUNDABLE"
|
|
5262
|
-
}
|
|
5263
|
-
/** @enumType */
|
|
5264
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
5265
|
-
declare enum NonRefundableReason {
|
|
5266
|
-
NONE = "NONE",
|
|
5267
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
5268
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
5269
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
5270
|
-
NOT_PAID = "NOT_PAID",
|
|
5271
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5272
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
5273
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5274
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
5275
|
-
FORBIDDEN = "FORBIDDEN",
|
|
5276
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5277
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5278
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5097
|
+
externalTransactionId?: string | null;
|
|
5098
|
+
/**
|
|
5099
|
+
* Whether the membership is voided.
|
|
5100
|
+
* @readonly
|
|
5101
|
+
* @deprecated Whether the membership is voided.
|
|
5102
|
+
* @replacedBy payment.status
|
|
5103
|
+
* @targetRemovalDate 2026-11-01
|
|
5104
|
+
*/
|
|
5105
|
+
voided?: boolean;
|
|
5106
|
+
/**
|
|
5107
|
+
* ID of the application providing this payment option.
|
|
5108
|
+
* @format GUID
|
|
5109
|
+
*/
|
|
5110
|
+
providerAppId?: string;
|
|
5111
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5112
|
+
futureMembership?: FutureMembershipDetails;
|
|
5279
5113
|
}
|
|
5280
|
-
|
|
5281
|
-
|
|
5282
|
-
|
|
5283
|
-
|
|
5284
|
-
|
|
5285
|
-
|
|
5286
|
-
|
|
5114
|
+
declare enum MembershipPaymentStatus {
|
|
5115
|
+
/** Payment was charged. */
|
|
5116
|
+
CHARGED = "CHARGED",
|
|
5117
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5118
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5119
|
+
/** Payment is pending. */
|
|
5120
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5121
|
+
/** Payment was voided. */
|
|
5122
|
+
VOIDED = "VOIDED"
|
|
5287
5123
|
}
|
|
5288
5124
|
/** @enumType */
|
|
5289
|
-
type
|
|
5290
|
-
interface
|
|
5125
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5126
|
+
interface FutureMembershipDetails {
|
|
5291
5127
|
/**
|
|
5292
|
-
*
|
|
5293
|
-
* @
|
|
5294
|
-
* @maxLength 100
|
|
5128
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
5129
|
+
* @format GUID
|
|
5295
5130
|
*/
|
|
5296
|
-
|
|
5297
|
-
/**
|
|
5298
|
-
|
|
5131
|
+
lineItemId?: string;
|
|
5132
|
+
/**
|
|
5133
|
+
* ID of the benefit the future membership will grant.
|
|
5134
|
+
* @maxLength 200
|
|
5135
|
+
*/
|
|
5136
|
+
benefitId?: string;
|
|
5299
5137
|
}
|
|
5300
|
-
interface
|
|
5138
|
+
interface WixReceiptInfo {
|
|
5301
5139
|
/**
|
|
5302
|
-
* ID
|
|
5140
|
+
* Receipt ID
|
|
5303
5141
|
* @format GUID
|
|
5304
5142
|
*/
|
|
5305
|
-
|
|
5143
|
+
receiptId?: string;
|
|
5306
5144
|
/**
|
|
5307
|
-
*
|
|
5145
|
+
* Display number of receipt
|
|
5308
5146
|
* @minLength 1
|
|
5309
|
-
* @maxLength
|
|
5147
|
+
* @maxLength 40
|
|
5310
5148
|
*/
|
|
5311
|
-
|
|
5312
|
-
}
|
|
5313
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
5314
|
-
/** ID of the order created in the payment gateway */
|
|
5315
|
-
paymentGatewayOrderId?: string;
|
|
5149
|
+
displayNumber?: string | null;
|
|
5316
5150
|
}
|
|
5317
|
-
interface
|
|
5151
|
+
interface ExternalReceiptInfo {
|
|
5318
5152
|
/**
|
|
5319
|
-
*
|
|
5320
|
-
* @minLength 1
|
|
5153
|
+
* External receipt ID
|
|
5321
5154
|
* @maxLength 100
|
|
5322
5155
|
*/
|
|
5323
|
-
|
|
5156
|
+
receiptId?: string | null;
|
|
5324
5157
|
/**
|
|
5325
|
-
*
|
|
5326
|
-
* but a user which is using the membership on behalf of the a member
|
|
5158
|
+
* ID of the app providing the receipt
|
|
5327
5159
|
* @format GUID
|
|
5328
5160
|
*/
|
|
5329
|
-
|
|
5161
|
+
appId?: string | null;
|
|
5330
5162
|
/**
|
|
5331
|
-
*
|
|
5332
|
-
* @
|
|
5333
|
-
* @
|
|
5163
|
+
* Display number of receipt
|
|
5164
|
+
* @minLength 1
|
|
5165
|
+
* @maxLength 40
|
|
5334
5166
|
*/
|
|
5335
|
-
|
|
5167
|
+
displayNumber?: string | null;
|
|
5336
5168
|
}
|
|
5337
|
-
interface
|
|
5169
|
+
interface CashRoundingDetails {
|
|
5338
5170
|
/**
|
|
5339
|
-
*
|
|
5340
|
-
*
|
|
5341
|
-
*
|
|
5171
|
+
* Payment amount before cash rounding was applied.
|
|
5172
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
5173
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
5342
5174
|
*/
|
|
5343
|
-
|
|
5175
|
+
unroundedAmount?: Price;
|
|
5344
5176
|
/**
|
|
5345
|
-
*
|
|
5177
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
5178
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
5179
|
+
* @readonly
|
|
5180
|
+
*/
|
|
5181
|
+
roundingAdjustment?: CashRounding;
|
|
5182
|
+
}
|
|
5183
|
+
declare enum PaymentStatus {
|
|
5184
|
+
/** Payment was charged successfully. */
|
|
5185
|
+
APPROVED = "APPROVED",
|
|
5186
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5187
|
+
PENDING = "PENDING",
|
|
5188
|
+
/** 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. */
|
|
5189
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5190
|
+
/** Payment was canceled before it was charged. */
|
|
5191
|
+
CANCELED = "CANCELED",
|
|
5192
|
+
/** Payment was declined by the payment provider. */
|
|
5193
|
+
DECLINED = "DECLINED",
|
|
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"
|
|
5206
|
+
}
|
|
5207
|
+
/** @enumType */
|
|
5208
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5209
|
+
interface CanceledStatusDetails {
|
|
5210
|
+
reason?: CanceledReasonWithLiterals;
|
|
5211
|
+
}
|
|
5212
|
+
declare enum CanceledReason {
|
|
5213
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5214
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5215
|
+
/** Payment was not completed by user and expired. */
|
|
5216
|
+
EXPIRED = "EXPIRED"
|
|
5217
|
+
}
|
|
5218
|
+
/** @enumType */
|
|
5219
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5220
|
+
interface DeclinedStatusDetails {
|
|
5221
|
+
reason?: DeclinedReasonWithLiterals;
|
|
5222
|
+
}
|
|
5223
|
+
declare enum DeclinedReason {
|
|
5224
|
+
/** Corresponding charge failed. */
|
|
5225
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5226
|
+
/** Payment details expired. */
|
|
5227
|
+
EXPIRED = "EXPIRED",
|
|
5228
|
+
/** Insufficient funds. */
|
|
5229
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5230
|
+
/** Gift card was disabled before charge was attempted. */
|
|
5231
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5232
|
+
}
|
|
5233
|
+
/** @enumType */
|
|
5234
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
5235
|
+
interface VoidedStatusDetails {
|
|
5236
|
+
reason?: VoidedReasonWithLiterals;
|
|
5237
|
+
}
|
|
5238
|
+
declare enum VoidedReason {
|
|
5239
|
+
/** Payment was voided by merchant request. */
|
|
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"
|
|
5243
|
+
}
|
|
5244
|
+
/** @enumType */
|
|
5245
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
5246
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
5247
|
+
}
|
|
5248
|
+
/** @oneof */
|
|
5249
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
5250
|
+
}
|
|
5251
|
+
interface Refund {
|
|
5252
|
+
/**
|
|
5253
|
+
* Refund ID.
|
|
5346
5254
|
* @format GUID
|
|
5255
|
+
* @readonly
|
|
5347
5256
|
*/
|
|
5348
|
-
|
|
5349
|
-
/** The name of used membership */
|
|
5350
|
-
membershipName?: MembershipName;
|
|
5351
|
-
/** Additional data about this membership */
|
|
5352
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
5353
|
-
/** Catalog and item reference info. */
|
|
5354
|
-
catalogReference?: CatalogReference;
|
|
5355
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5356
|
-
serviceProperties?: ServiceProperties;
|
|
5257
|
+
id?: string;
|
|
5357
5258
|
/**
|
|
5358
|
-
*
|
|
5359
|
-
*
|
|
5360
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
5361
|
-
* @minLength 1
|
|
5362
|
-
* @maxLength 36
|
|
5259
|
+
* List of transactions.
|
|
5260
|
+
* @maxSize 50
|
|
5363
5261
|
*/
|
|
5364
|
-
|
|
5262
|
+
transactions?: RefundTransaction[];
|
|
5263
|
+
/** Refund business details. */
|
|
5264
|
+
details?: RefundDetails;
|
|
5365
5265
|
/**
|
|
5366
|
-
*
|
|
5367
|
-
* @
|
|
5368
|
-
* @
|
|
5266
|
+
* 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.
|
|
5267
|
+
* @readonly
|
|
5268
|
+
* @immutable
|
|
5369
5269
|
*/
|
|
5370
|
-
|
|
5371
|
-
}
|
|
5372
|
-
interface MembershipName {
|
|
5270
|
+
createdDate?: Date | null;
|
|
5373
5271
|
/**
|
|
5374
|
-
*
|
|
5375
|
-
* @
|
|
5272
|
+
* Aggregated refund summary.
|
|
5273
|
+
* @readonly
|
|
5376
5274
|
*/
|
|
5377
|
-
|
|
5275
|
+
summary?: AggregatedRefundSummary;
|
|
5378
5276
|
/**
|
|
5379
|
-
*
|
|
5380
|
-
*
|
|
5381
|
-
*
|
|
5382
|
-
* @
|
|
5277
|
+
* ID of the app that initiated this refund.
|
|
5278
|
+
* @format GUID
|
|
5279
|
+
* @readonly
|
|
5280
|
+
* @immutable
|
|
5383
5281
|
*/
|
|
5384
|
-
|
|
5385
|
-
}
|
|
5386
|
-
interface ChargeMembershipsResponse {
|
|
5282
|
+
requestingServiceAppId?: string | null;
|
|
5387
5283
|
}
|
|
5388
|
-
interface
|
|
5284
|
+
interface RefundTransaction {
|
|
5389
5285
|
/**
|
|
5390
|
-
*
|
|
5391
|
-
* @
|
|
5392
|
-
* @
|
|
5286
|
+
* ID of the payment associated with this refund.
|
|
5287
|
+
* @format GUID
|
|
5288
|
+
* @immutable
|
|
5393
5289
|
*/
|
|
5394
|
-
|
|
5290
|
+
paymentId?: string;
|
|
5395
5291
|
/**
|
|
5396
|
-
* Refund
|
|
5397
|
-
* @
|
|
5398
|
-
* @maxSize 1
|
|
5292
|
+
* Refund amount.
|
|
5293
|
+
* @immutable
|
|
5399
5294
|
*/
|
|
5400
|
-
|
|
5401
|
-
/**
|
|
5402
|
-
|
|
5403
|
-
/**
|
|
5404
|
-
|
|
5405
|
-
}
|
|
5406
|
-
interface PaymentRefund {
|
|
5295
|
+
amount?: Price;
|
|
5296
|
+
/** Refund status. */
|
|
5297
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5298
|
+
/** Optional details of current refund status. */
|
|
5299
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
5407
5300
|
/**
|
|
5408
|
-
*
|
|
5301
|
+
* Payment gateway's refund ID.
|
|
5302
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
5409
5303
|
* @format GUID
|
|
5410
5304
|
*/
|
|
5411
|
-
|
|
5412
|
-
/**
|
|
5413
|
-
|
|
5305
|
+
gatewayRefundId?: string | null;
|
|
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;
|
|
5414
5308
|
/**
|
|
5415
|
-
* Whether refund
|
|
5416
|
-
*
|
|
5417
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5309
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5310
|
+
* @immutable
|
|
5418
5311
|
*/
|
|
5419
5312
|
externalRefund?: boolean;
|
|
5420
5313
|
}
|
|
5421
|
-
|
|
5422
|
-
|
|
5423
|
-
|
|
5424
|
-
|
|
5425
|
-
|
|
5314
|
+
/** Refund transaction status. */
|
|
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"
|
|
5326
|
+
}
|
|
5327
|
+
/** @enumType */
|
|
5328
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5329
|
+
interface RefundStatusInfo {
|
|
5426
5330
|
/**
|
|
5427
|
-
*
|
|
5331
|
+
* Reason code for the refund's current status.
|
|
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).
|
|
5334
|
+
* @minLength 1
|
|
5335
|
+
* @maxLength 10
|
|
5336
|
+
*/
|
|
5337
|
+
paymentGatewayReasonCode?: string | null;
|
|
5338
|
+
/**
|
|
5339
|
+
* Free text explanation of current refund status.
|
|
5428
5340
|
* @minLength 1
|
|
5429
5341
|
* @maxLength 1000
|
|
5430
5342
|
*/
|
|
5431
|
-
|
|
5343
|
+
description?: string | null;
|
|
5432
5344
|
}
|
|
5433
|
-
interface
|
|
5434
|
-
/**
|
|
5435
|
-
|
|
5345
|
+
interface AggregatedRefundSummary {
|
|
5346
|
+
/** Total amount requested for refund. */
|
|
5347
|
+
requestedRefund?: Price;
|
|
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;
|
|
5358
|
+
}
|
|
5359
|
+
interface RefundItemsBreakdown {
|
|
5436
5360
|
/**
|
|
5437
|
-
*
|
|
5361
|
+
* Refunded line items and the amount refunded for each.
|
|
5438
5362
|
* @maxSize 300
|
|
5439
5363
|
*/
|
|
5440
|
-
|
|
5441
|
-
}
|
|
5442
|
-
declare enum RestockType {
|
|
5443
|
-
NO_ITEMS = "NO_ITEMS",
|
|
5444
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
5445
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
5364
|
+
lineItems?: LineItemRefundSummary[];
|
|
5446
5365
|
}
|
|
5447
|
-
|
|
5448
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5449
|
-
interface RestockItem {
|
|
5366
|
+
interface LineItemRefundSummary {
|
|
5450
5367
|
/**
|
|
5451
|
-
* ID of the line item
|
|
5368
|
+
* ID of the refunded line item.
|
|
5452
5369
|
* @format GUID
|
|
5453
5370
|
*/
|
|
5454
5371
|
lineItemId?: string;
|
|
5455
|
-
/**
|
|
5456
|
-
|
|
5457
|
-
* @min 1
|
|
5458
|
-
* @max 100000
|
|
5459
|
-
*/
|
|
5460
|
-
quantity?: number;
|
|
5461
|
-
}
|
|
5462
|
-
interface TriggerRefundResponse {
|
|
5463
|
-
/** All order's transactions after the refunds were added */
|
|
5464
|
-
orderTransactions?: OrderTransactions;
|
|
5465
|
-
/** Created refund ID */
|
|
5466
|
-
refundId?: string | null;
|
|
5467
|
-
/** Payment ID's that the refund execution had failed for */
|
|
5468
|
-
failedPaymentIds?: ItemMetadata[];
|
|
5372
|
+
/** Total refunded amount for the line item. */
|
|
5373
|
+
totalRefundedAmount?: Price;
|
|
5469
5374
|
}
|
|
5470
|
-
|
|
5471
|
-
* A record of all payments and refunds associated with an order.
|
|
5472
|
-
*
|
|
5473
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5474
|
-
*/
|
|
5475
|
-
interface OrderTransactions {
|
|
5476
|
-
/**
|
|
5477
|
-
* Order ID.
|
|
5478
|
-
* @format GUID
|
|
5479
|
-
*/
|
|
5480
|
-
orderId?: string;
|
|
5375
|
+
interface CalculateRefundRequest {
|
|
5481
5376
|
/**
|
|
5482
|
-
*
|
|
5483
|
-
* @
|
|
5377
|
+
* Order ID
|
|
5378
|
+
* @minLength 1
|
|
5379
|
+
* @maxLength 100
|
|
5484
5380
|
*/
|
|
5485
|
-
|
|
5381
|
+
ecomOrderId?: string;
|
|
5486
5382
|
/**
|
|
5487
|
-
*
|
|
5383
|
+
* Refunded line items and quantity
|
|
5488
5384
|
* @maxSize 300
|
|
5489
5385
|
*/
|
|
5490
|
-
|
|
5386
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5387
|
+
/** Should include shipping in refund calculation */
|
|
5388
|
+
refundShipping?: boolean;
|
|
5491
5389
|
}
|
|
5492
|
-
interface
|
|
5493
|
-
/** Regular payment details. */
|
|
5494
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
5495
|
-
/** Gift card payment details. */
|
|
5496
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5497
|
-
/** Membership payment details. */
|
|
5498
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5390
|
+
interface CalculateRefundItemRequest {
|
|
5499
5391
|
/**
|
|
5500
|
-
*
|
|
5392
|
+
* ID of the line item being refunded
|
|
5501
5393
|
* @format GUID
|
|
5502
|
-
* @readonly
|
|
5503
|
-
*/
|
|
5504
|
-
id?: string | null;
|
|
5505
|
-
/** 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. */
|
|
5506
|
-
createdDate?: Date | null;
|
|
5507
|
-
/**
|
|
5508
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5509
|
-
* @readonly
|
|
5510
|
-
*/
|
|
5511
|
-
updatedDate?: Date | null;
|
|
5512
|
-
/** Payment amount. */
|
|
5513
|
-
amount?: Price;
|
|
5514
|
-
/**
|
|
5515
|
-
* Whether refunds for this payment are disabled.
|
|
5516
|
-
* + `true`: This payment is not refundable.
|
|
5517
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5518
5394
|
*/
|
|
5519
|
-
|
|
5520
|
-
/**
|
|
5521
|
-
* Whether receipt generation is allowed for this payment.
|
|
5522
|
-
* + `true`: This payment supports receipt generation.
|
|
5523
|
-
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5524
|
-
* @readonly
|
|
5525
|
-
*/
|
|
5526
|
-
supportReceiptGeneration?: boolean;
|
|
5527
|
-
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5528
|
-
cashRounding?: CashRoundingDetails;
|
|
5395
|
+
id?: string;
|
|
5529
5396
|
/**
|
|
5530
|
-
*
|
|
5531
|
-
*
|
|
5532
|
-
*
|
|
5397
|
+
* How much of that line item is being refunded
|
|
5398
|
+
* @min 1
|
|
5399
|
+
* @max 100000
|
|
5533
5400
|
*/
|
|
5534
|
-
|
|
5401
|
+
quantity?: number;
|
|
5402
|
+
}
|
|
5403
|
+
interface CalculateRefundResponse {
|
|
5404
|
+
/** Total refundable amount */
|
|
5405
|
+
total?: Price;
|
|
5406
|
+
/** Tax cost of the order */
|
|
5407
|
+
tax?: Price;
|
|
5408
|
+
/** Discount given for this order */
|
|
5409
|
+
discount?: Price;
|
|
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;
|
|
5535
5416
|
/**
|
|
5536
|
-
*
|
|
5537
|
-
* @
|
|
5417
|
+
* The refundable items of that order
|
|
5418
|
+
* @maxSize 300
|
|
5538
5419
|
*/
|
|
5539
|
-
|
|
5540
|
-
}
|
|
5541
|
-
/** @oneof */
|
|
5542
|
-
interface PaymentPaymentDetailsOneOf {
|
|
5543
|
-
/** Regular payment details. */
|
|
5544
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
5545
|
-
/** Gift card payment details. */
|
|
5546
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5547
|
-
/** Membership payment details. */
|
|
5548
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5549
|
-
}
|
|
5550
|
-
/** @oneof */
|
|
5551
|
-
interface PaymentReceiptInfoOneOf {
|
|
5552
|
-
}
|
|
5553
|
-
/** @oneof */
|
|
5554
|
-
interface PaymentStatusDetailsOneOf {
|
|
5420
|
+
items?: CalculateRefundItemResponse[];
|
|
5555
5421
|
}
|
|
5556
|
-
interface
|
|
5557
|
-
/** Credit card details. */
|
|
5558
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5422
|
+
interface CalculateRefundItemResponse {
|
|
5559
5423
|
/**
|
|
5560
|
-
*
|
|
5561
|
-
* @
|
|
5424
|
+
* Line item ID
|
|
5425
|
+
* @format GUID
|
|
5562
5426
|
*/
|
|
5563
|
-
|
|
5427
|
+
id?: string;
|
|
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 {
|
|
5564
5432
|
/**
|
|
5565
|
-
*
|
|
5566
|
-
*
|
|
5433
|
+
* Wix eCommerce order ID
|
|
5434
|
+
* @minLength 1
|
|
5567
5435
|
* @maxLength 100
|
|
5568
5436
|
*/
|
|
5569
|
-
|
|
5437
|
+
ecomOrderId: string;
|
|
5570
5438
|
/**
|
|
5571
|
-
* Payment
|
|
5572
|
-
*
|
|
5573
|
-
*
|
|
5574
|
-
*
|
|
5575
|
-
* @maxLength 150
|
|
5576
|
-
* @deprecated Payment method.
|
|
5577
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5578
|
-
* Non-exhaustive list of supported values:
|
|
5579
|
-
* + `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`
|
|
5580
|
-
* @replacedBy payment_method_name
|
|
5581
|
-
* @targetRemovalDate 2026-07-01
|
|
5439
|
+
* Payment IDs
|
|
5440
|
+
* @minSize 1
|
|
5441
|
+
* @maxSize 100
|
|
5442
|
+
* @format GUID
|
|
5582
5443
|
*/
|
|
5583
|
-
|
|
5444
|
+
paymentIds: string[];
|
|
5445
|
+
}
|
|
5446
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
5447
|
+
/** All order's transactions after the void was triggered */
|
|
5448
|
+
orderTransactions?: OrderTransactions;
|
|
5449
|
+
}
|
|
5450
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
5584
5451
|
/**
|
|
5585
|
-
*
|
|
5452
|
+
* Wix eCommerce order ID
|
|
5453
|
+
* @minLength 1
|
|
5586
5454
|
* @maxLength 100
|
|
5587
5455
|
*/
|
|
5588
|
-
|
|
5589
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5590
|
-
offlinePayment?: boolean;
|
|
5456
|
+
ecomOrderId: string;
|
|
5591
5457
|
/**
|
|
5592
|
-
*
|
|
5593
|
-
* @
|
|
5594
|
-
* @
|
|
5595
|
-
* @targetRemovalDate 2026-11-01
|
|
5458
|
+
* Capture payments information
|
|
5459
|
+
* @minSize 1
|
|
5460
|
+
* @maxSize 100
|
|
5596
5461
|
*/
|
|
5597
|
-
|
|
5598
|
-
|
|
5599
|
-
|
|
5600
|
-
/** Authorization details. */
|
|
5601
|
-
authorizationDetails?: AuthorizationDetails;
|
|
5462
|
+
payments: PaymentCapture[];
|
|
5463
|
+
}
|
|
5464
|
+
interface PaymentCapture {
|
|
5602
5465
|
/**
|
|
5603
|
-
*
|
|
5604
|
-
* @
|
|
5466
|
+
* Payment ID
|
|
5467
|
+
* @format GUID
|
|
5605
5468
|
*/
|
|
5606
|
-
|
|
5607
|
-
/** Platform fee amount associated with this payment. */
|
|
5608
|
-
platformFee?: Price;
|
|
5469
|
+
paymentId?: string | null;
|
|
5609
5470
|
/**
|
|
5610
|
-
*
|
|
5611
|
-
*
|
|
5612
|
-
* + `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`
|
|
5471
|
+
* Capture amount.
|
|
5472
|
+
* If not provided - full authorized amount will be captured.
|
|
5613
5473
|
*/
|
|
5614
|
-
|
|
5615
|
-
}
|
|
5616
|
-
/** @oneof */
|
|
5617
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5618
|
-
/** Credit card details. */
|
|
5619
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5474
|
+
amount?: Price;
|
|
5620
5475
|
}
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
PENDING = "PENDING",
|
|
5625
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5626
|
-
CANCELED = "CANCELED",
|
|
5627
|
-
DECLINED = "DECLINED",
|
|
5628
|
-
REFUNDED = "REFUNDED",
|
|
5629
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5630
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5631
|
-
VOIDED = "VOIDED"
|
|
5476
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
5477
|
+
/** All order's transactions after the capture was triggered */
|
|
5478
|
+
orderTransactions?: OrderTransactions;
|
|
5632
5479
|
}
|
|
5633
|
-
|
|
5634
|
-
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5635
|
-
interface CreditCardPaymentMethodDetails {
|
|
5636
|
-
/**
|
|
5637
|
-
* The last 4 digits of the card number.
|
|
5638
|
-
* @maxLength 4
|
|
5639
|
-
*/
|
|
5640
|
-
lastFourDigits?: string | null;
|
|
5480
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
5641
5481
|
/**
|
|
5642
|
-
*
|
|
5482
|
+
* Ecom Order ID.
|
|
5483
|
+
* @minLength 1
|
|
5643
5484
|
* @maxLength 100
|
|
5644
5485
|
*/
|
|
5645
|
-
|
|
5486
|
+
ecomOrderId?: string;
|
|
5487
|
+
/** Amount to be charged */
|
|
5488
|
+
amount?: Price;
|
|
5646
5489
|
}
|
|
5647
|
-
interface
|
|
5648
|
-
/**
|
|
5649
|
-
|
|
5650
|
-
|
|
5651
|
-
|
|
5652
|
-
|
|
5653
|
-
|
|
5654
|
-
|
|
5490
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
5491
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
5492
|
+
paymentGatewayOrderId?: string;
|
|
5493
|
+
}
|
|
5494
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
5495
|
+
/** @format GUID */
|
|
5496
|
+
orderId?: string;
|
|
5497
|
+
}
|
|
5498
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
5499
|
+
}
|
|
5500
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
5655
5501
|
/**
|
|
5656
|
-
*
|
|
5657
|
-
*
|
|
5658
|
-
* @maxSize 1
|
|
5502
|
+
* @minLength 1
|
|
5503
|
+
* @maxLength 100
|
|
5659
5504
|
*/
|
|
5660
|
-
|
|
5661
|
-
/** Void associated with payment */
|
|
5662
|
-
void?: AuthorizationVoid;
|
|
5663
|
-
/** Scheduled action for this transaction */
|
|
5664
|
-
scheduledAction?: V1ScheduledAction;
|
|
5505
|
+
orderId?: string;
|
|
5665
5506
|
}
|
|
5666
|
-
interface
|
|
5507
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
5508
|
+
}
|
|
5509
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
5667
5510
|
/**
|
|
5668
|
-
*
|
|
5669
|
-
* @
|
|
5670
|
-
* @readonly
|
|
5511
|
+
* @minLength 1
|
|
5512
|
+
* @maxLength 100
|
|
5671
5513
|
*/
|
|
5672
|
-
|
|
5673
|
-
|
|
5674
|
-
|
|
5514
|
+
orderId?: string;
|
|
5515
|
+
}
|
|
5516
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
5517
|
+
}
|
|
5518
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
5675
5519
|
/**
|
|
5676
|
-
*
|
|
5677
|
-
* @
|
|
5520
|
+
* IDs of orders to send pickup emails for.
|
|
5521
|
+
* @minSize 1
|
|
5522
|
+
* @maxSize 300
|
|
5678
5523
|
*/
|
|
5679
|
-
|
|
5680
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5681
|
-
createdDate?: Date | null;
|
|
5682
|
-
/** In case of status is FAILED may contain failure details */
|
|
5683
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5524
|
+
orderIds?: string[];
|
|
5684
5525
|
}
|
|
5685
|
-
|
|
5686
|
-
/** Capture operation still in progress. */
|
|
5687
|
-
PENDING = "PENDING",
|
|
5688
|
-
/** Capture operation succeeded. */
|
|
5689
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5690
|
-
/** Capture operation failed. */
|
|
5691
|
-
FAILED = "FAILED"
|
|
5526
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5692
5527
|
}
|
|
5693
|
-
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5528
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
5529
|
+
/**
|
|
5530
|
+
* @minLength 1
|
|
5531
|
+
* @maxLength 100
|
|
5532
|
+
*/
|
|
5533
|
+
orderId?: string;
|
|
5698
5534
|
}
|
|
5699
|
-
interface
|
|
5700
|
-
/** Status of this void action */
|
|
5701
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
5702
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5703
|
-
voidedDate?: Date | null;
|
|
5704
|
-
/** In case of status is FAILED may contain failure details */
|
|
5705
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5706
|
-
/** Reason of void action */
|
|
5707
|
-
reason?: ReasonWithLiterals;
|
|
5535
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
5708
5536
|
}
|
|
5709
|
-
|
|
5710
|
-
/**
|
|
5711
|
-
|
|
5712
|
-
|
|
5713
|
-
|
|
5714
|
-
|
|
5715
|
-
|
|
5537
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
5538
|
+
/**
|
|
5539
|
+
* IDs of orders to send pickup emails for.
|
|
5540
|
+
* @minSize 1
|
|
5541
|
+
* @maxSize 300
|
|
5542
|
+
*/
|
|
5543
|
+
orderIds?: string[];
|
|
5716
5544
|
}
|
|
5717
|
-
|
|
5718
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5719
|
-
/** Reason the authorization was voided. */
|
|
5720
|
-
declare enum Reason {
|
|
5721
|
-
/** Authorization was voided by user. */
|
|
5722
|
-
MANUAL = "MANUAL",
|
|
5723
|
-
/** Authorization passed execution date. */
|
|
5724
|
-
SCHEDULED = "SCHEDULED"
|
|
5545
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
5725
5546
|
}
|
|
5726
|
-
|
|
5727
|
-
|
|
5728
|
-
|
|
5729
|
-
|
|
5730
|
-
|
|
5731
|
-
|
|
5732
|
-
executionDate?: Date | null;
|
|
5547
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
5548
|
+
/**
|
|
5549
|
+
* @minLength 1
|
|
5550
|
+
* @maxLength 100
|
|
5551
|
+
*/
|
|
5552
|
+
orderId?: string;
|
|
5733
5553
|
}
|
|
5734
|
-
|
|
5735
|
-
VOID = "VOID",
|
|
5736
|
-
CAPTURE = "CAPTURE"
|
|
5554
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5737
5555
|
}
|
|
5738
|
-
|
|
5739
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5740
|
-
interface Chargeback {
|
|
5556
|
+
interface SendCancelRefundEmailRequest {
|
|
5741
5557
|
/**
|
|
5742
|
-
*
|
|
5743
|
-
* @
|
|
5744
|
-
* @
|
|
5745
|
-
* @immutable
|
|
5558
|
+
* The ID of order that is canceled/refunded
|
|
5559
|
+
* @minLength 1
|
|
5560
|
+
* @maxLength 100
|
|
5746
5561
|
*/
|
|
5747
|
-
|
|
5562
|
+
orderId?: string;
|
|
5748
5563
|
/**
|
|
5749
|
-
*
|
|
5750
|
-
* @
|
|
5751
|
-
* @
|
|
5564
|
+
* Personal note added to the email (optional)
|
|
5565
|
+
* @minLength 1
|
|
5566
|
+
* @maxLength 1000
|
|
5752
5567
|
*/
|
|
5753
|
-
|
|
5568
|
+
customMessage?: string | null;
|
|
5569
|
+
/** Refund amount */
|
|
5570
|
+
refundAmount?: Price;
|
|
5754
5571
|
/**
|
|
5755
|
-
*
|
|
5756
|
-
* @
|
|
5572
|
+
* Refund ID. (Optional)
|
|
5573
|
+
* @format GUID
|
|
5757
5574
|
*/
|
|
5758
|
-
|
|
5575
|
+
refundId?: string | null;
|
|
5576
|
+
}
|
|
5577
|
+
interface SendCancelRefundEmailResponse {
|
|
5578
|
+
}
|
|
5579
|
+
interface SendRefundEmailRequest {
|
|
5759
5580
|
/**
|
|
5760
|
-
*
|
|
5761
|
-
* @
|
|
5762
|
-
* @immutable
|
|
5581
|
+
* The ID of order that is refunded
|
|
5582
|
+
* @format GUID
|
|
5763
5583
|
*/
|
|
5764
|
-
|
|
5584
|
+
orderId?: string;
|
|
5765
5585
|
/**
|
|
5766
|
-
*
|
|
5767
|
-
* @
|
|
5586
|
+
* Refund ID
|
|
5587
|
+
* @format GUID
|
|
5768
5588
|
*/
|
|
5769
|
-
|
|
5589
|
+
refundId?: string;
|
|
5770
5590
|
/**
|
|
5771
|
-
*
|
|
5772
|
-
*
|
|
5773
|
-
*
|
|
5591
|
+
* Personal note added to the email (optional)
|
|
5592
|
+
* @minLength 1
|
|
5593
|
+
* @maxLength 1000
|
|
5774
5594
|
*/
|
|
5775
|
-
|
|
5595
|
+
customMessage?: string | null;
|
|
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 {
|
|
5776
5608
|
/**
|
|
5777
|
-
*
|
|
5778
|
-
* @
|
|
5779
|
-
* @readonly
|
|
5780
|
-
* @immutable
|
|
5609
|
+
* @minLength 1
|
|
5610
|
+
* @maxLength 100
|
|
5781
5611
|
*/
|
|
5782
|
-
|
|
5612
|
+
orderId?: string;
|
|
5783
5613
|
}
|
|
5784
|
-
|
|
5785
|
-
|
|
5786
|
-
|
|
5787
|
-
|
|
5788
|
-
|
|
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"
|
|
5789
5624
|
}
|
|
5790
5625
|
/** @enumType */
|
|
5791
|
-
type
|
|
5792
|
-
interface
|
|
5626
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
5627
|
+
interface PreviewEmailByTypeResponse {
|
|
5628
|
+
emailPreview?: string;
|
|
5629
|
+
}
|
|
5630
|
+
interface PreviewRefundEmailRequest {
|
|
5793
5631
|
/**
|
|
5794
|
-
*
|
|
5795
|
-
* @maxLength
|
|
5632
|
+
* @minLength 1
|
|
5633
|
+
* @maxLength 100
|
|
5796
5634
|
*/
|
|
5797
|
-
|
|
5635
|
+
orderId?: string;
|
|
5636
|
+
/** Refund amount */
|
|
5637
|
+
refundAmount?: Price;
|
|
5638
|
+
/** Refund business details */
|
|
5639
|
+
details?: RefundDetails;
|
|
5798
5640
|
/**
|
|
5799
|
-
*
|
|
5800
|
-
*
|
|
5801
|
-
*
|
|
5802
|
-
* @maxLength 150
|
|
5641
|
+
* Personal note added to the email (optional)
|
|
5642
|
+
* @minLength 1
|
|
5643
|
+
* @maxLength 1000
|
|
5803
5644
|
*/
|
|
5804
|
-
|
|
5645
|
+
customMessage?: string | null;
|
|
5805
5646
|
/**
|
|
5806
|
-
*
|
|
5807
|
-
*
|
|
5808
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5647
|
+
* Refund ID. (Optional)
|
|
5648
|
+
* @format GUID
|
|
5809
5649
|
*/
|
|
5810
|
-
|
|
5650
|
+
refundId?: string | null;
|
|
5811
5651
|
}
|
|
5812
|
-
interface
|
|
5652
|
+
interface PreviewRefundEmailResponse {
|
|
5653
|
+
emailPreview?: string;
|
|
5654
|
+
}
|
|
5655
|
+
interface PreviewCancelEmailRequest {
|
|
5813
5656
|
/**
|
|
5814
|
-
*
|
|
5657
|
+
* @minLength 1
|
|
5815
5658
|
* @maxLength 100
|
|
5816
5659
|
*/
|
|
5817
|
-
|
|
5660
|
+
orderId?: string;
|
|
5818
5661
|
/**
|
|
5819
|
-
*
|
|
5820
|
-
* @
|
|
5662
|
+
* Personal note added to the email (optional)
|
|
5663
|
+
* @minLength 1
|
|
5664
|
+
* @maxLength 1000
|
|
5821
5665
|
*/
|
|
5822
|
-
|
|
5666
|
+
customMessage?: string | null;
|
|
5667
|
+
}
|
|
5668
|
+
interface PreviewCancelEmailResponse {
|
|
5669
|
+
emailPreview?: string;
|
|
5670
|
+
}
|
|
5671
|
+
interface PreviewCancelRefundEmailRequest {
|
|
5823
5672
|
/**
|
|
5824
|
-
*
|
|
5825
|
-
* @
|
|
5826
|
-
* @deprecated Whether the gift card is voided.
|
|
5827
|
-
* @replacedBy payment.status
|
|
5828
|
-
* @targetRemovalDate 2026-11-01
|
|
5673
|
+
* @minLength 1
|
|
5674
|
+
* @maxLength 100
|
|
5829
5675
|
*/
|
|
5830
|
-
|
|
5676
|
+
orderId?: string;
|
|
5831
5677
|
/**
|
|
5832
|
-
*
|
|
5833
|
-
* @
|
|
5834
|
-
* @
|
|
5678
|
+
* Personal note added to the email (optional)
|
|
5679
|
+
* @minLength 1
|
|
5680
|
+
* @maxLength 1000
|
|
5835
5681
|
*/
|
|
5836
|
-
|
|
5682
|
+
customMessage?: string | null;
|
|
5683
|
+
/** Refund amount */
|
|
5684
|
+
refundAmount?: Price;
|
|
5685
|
+
/**
|
|
5686
|
+
* Refund ID. (Optional)
|
|
5687
|
+
* @format GUID
|
|
5688
|
+
*/
|
|
5689
|
+
refundId?: string | null;
|
|
5837
5690
|
}
|
|
5838
|
-
interface
|
|
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;
|
|
5839
5750
|
/**
|
|
5840
|
-
*
|
|
5841
|
-
*
|
|
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
|
|
5842
5756
|
*/
|
|
5843
|
-
|
|
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;
|
|
5844
5784
|
/**
|
|
5845
|
-
*
|
|
5846
|
-
* @
|
|
5847
|
-
* @maxLength 100
|
|
5785
|
+
* A meta site id.
|
|
5786
|
+
* @format GUID
|
|
5848
5787
|
*/
|
|
5849
|
-
|
|
5788
|
+
metaSiteId?: string;
|
|
5789
|
+
/** A meta site version. Monotonically increasing. */
|
|
5790
|
+
version?: string;
|
|
5791
|
+
/** A timestamp of the event. */
|
|
5792
|
+
timestamp?: string;
|
|
5850
5793
|
/**
|
|
5851
|
-
*
|
|
5852
|
-
*
|
|
5853
|
-
* @
|
|
5854
|
-
* @targetRemovalDate 2026-11-01
|
|
5794
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
5795
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
5796
|
+
* @maxSize 4000
|
|
5855
5797
|
*/
|
|
5856
|
-
|
|
5857
|
-
|
|
5858
|
-
|
|
5798
|
+
assets?: Asset[];
|
|
5799
|
+
}
|
|
5800
|
+
/** @oneof */
|
|
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;
|
|
5859
5832
|
/**
|
|
5860
|
-
*
|
|
5861
|
-
*
|
|
5862
|
-
*
|
|
5833
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5834
|
+
* the actual URL.
|
|
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
5838
|
*/
|
|
5864
|
-
|
|
5839
|
+
urlChanged?: SiteUrlChanged;
|
|
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 {
|
|
5865
5868
|
/**
|
|
5866
|
-
*
|
|
5867
|
-
* @
|
|
5868
|
-
* @deprecated Whether the membership is voided.
|
|
5869
|
-
* @replacedBy payment.status
|
|
5870
|
-
* @targetRemovalDate 2026-11-01
|
|
5869
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
5870
|
+
* @maxLength 36
|
|
5871
5871
|
*/
|
|
5872
|
-
|
|
5872
|
+
appDefId?: string;
|
|
5873
5873
|
/**
|
|
5874
|
-
*
|
|
5875
|
-
* @
|
|
5874
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
5875
|
+
* @maxLength 200
|
|
5876
5876
|
*/
|
|
5877
|
-
|
|
5878
|
-
/**
|
|
5879
|
-
|
|
5877
|
+
instanceId?: string;
|
|
5878
|
+
/** An application state. */
|
|
5879
|
+
state?: StateWithLiterals;
|
|
5880
5880
|
}
|
|
5881
|
-
declare enum
|
|
5882
|
-
|
|
5883
|
-
|
|
5884
|
-
|
|
5885
|
-
|
|
5886
|
-
|
|
5887
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5888
|
-
/** Payment was voided. */
|
|
5889
|
-
VOIDED = "VOIDED"
|
|
5881
|
+
declare enum State {
|
|
5882
|
+
UNKNOWN = "UNKNOWN",
|
|
5883
|
+
ENABLED = "ENABLED",
|
|
5884
|
+
DISABLED = "DISABLED",
|
|
5885
|
+
PENDING = "PENDING",
|
|
5886
|
+
DEMO = "DEMO"
|
|
5890
5887
|
}
|
|
5891
5888
|
/** @enumType */
|
|
5892
|
-
type
|
|
5893
|
-
interface
|
|
5889
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5890
|
+
interface SiteCreated {
|
|
5894
5891
|
/**
|
|
5895
|
-
*
|
|
5896
|
-
* @
|
|
5892
|
+
* A template identifier (empty if not created from a template).
|
|
5893
|
+
* @maxLength 36
|
|
5897
5894
|
*/
|
|
5898
|
-
|
|
5895
|
+
originTemplateId?: string;
|
|
5899
5896
|
/**
|
|
5900
|
-
*
|
|
5901
|
-
* @
|
|
5897
|
+
* An account id of the owner.
|
|
5898
|
+
* @format GUID
|
|
5902
5899
|
*/
|
|
5903
|
-
|
|
5904
|
-
|
|
5905
|
-
|
|
5900
|
+
ownerId?: string;
|
|
5901
|
+
/** A context in which meta site was created. */
|
|
5902
|
+
context?: SiteCreatedContextWithLiterals;
|
|
5906
5903
|
/**
|
|
5907
|
-
*
|
|
5904
|
+
* A meta site id from which this site was created.
|
|
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.
|
|
5908
5908
|
* @format GUID
|
|
5909
5909
|
*/
|
|
5910
|
-
|
|
5910
|
+
originMetaSiteId?: string | null;
|
|
5911
5911
|
/**
|
|
5912
|
-
*
|
|
5913
|
-
* @
|
|
5914
|
-
* @maxLength 40
|
|
5912
|
+
* A meta site name (URL slug).
|
|
5913
|
+
* @maxLength 20
|
|
5915
5914
|
*/
|
|
5916
|
-
|
|
5915
|
+
siteName?: string;
|
|
5916
|
+
/** A namespace. */
|
|
5917
|
+
namespace?: NamespaceWithLiterals;
|
|
5917
5918
|
}
|
|
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"
|
|
5932
|
+
}
|
|
5933
|
+
/** @enumType */
|
|
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",
|
|
5919
5951
|
/**
|
|
5920
|
-
*
|
|
5921
|
-
*
|
|
5952
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5953
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
5922
5954
|
*/
|
|
5923
|
-
|
|
5955
|
+
DEV_SITE = "DEV_SITE",
|
|
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",
|
|
5924
5964
|
/**
|
|
5925
|
-
*
|
|
5926
|
-
*
|
|
5965
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5966
|
+
*
|
|
5967
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5927
5968
|
*/
|
|
5928
|
-
|
|
5969
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
5929
5970
|
/**
|
|
5930
|
-
*
|
|
5931
|
-
*
|
|
5932
|
-
*
|
|
5971
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
5972
|
+
* Will be accessible from Site List and will not have a website app.
|
|
5973
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
5933
5974
|
*/
|
|
5934
|
-
|
|
5935
|
-
|
|
5936
|
-
|
|
5975
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
5976
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5977
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
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",
|
|
5937
5984
|
/**
|
|
5938
|
-
*
|
|
5939
|
-
*
|
|
5940
|
-
* to prevent false overpayment or underpayment due to rounding.
|
|
5985
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
5986
|
+
* The site will be used for account level CSM feature for enterprise
|
|
5941
5987
|
*/
|
|
5942
|
-
|
|
5988
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
5989
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
5990
|
+
RISE = "RISE",
|
|
5943
5991
|
/**
|
|
5944
|
-
*
|
|
5945
|
-
*
|
|
5946
|
-
*
|
|
5992
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
5993
|
+
* There's a blank site behind the scene but it's blank).
|
|
5994
|
+
* The Mobile company will be the owner of this namespace.
|
|
5947
5995
|
*/
|
|
5948
|
-
|
|
5949
|
-
|
|
5950
|
-
|
|
5951
|
-
/** Payment was charged successfully. */
|
|
5952
|
-
APPROVED = "APPROVED",
|
|
5953
|
-
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5954
|
-
PENDING = "PENDING",
|
|
5955
|
-
/** 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. */
|
|
5956
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5957
|
-
/** Payment was canceled before it was charged. */
|
|
5958
|
-
CANCELED = "CANCELED",
|
|
5959
|
-
/** Payment was declined by the payment provider. */
|
|
5960
|
-
DECLINED = "DECLINED",
|
|
5961
|
-
/** Payment was fully refunded. */
|
|
5962
|
-
REFUNDED = "REFUNDED",
|
|
5963
|
-
/** Part of the payment amount was refunded. */
|
|
5964
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5965
|
-
/** 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. */
|
|
5966
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5996
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
5997
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5998
|
+
NOWNIA = "NOWNIA",
|
|
5967
5999
|
/**
|
|
5968
|
-
*
|
|
5969
|
-
*
|
|
5970
|
-
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
6000
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
6001
|
+
* The Partners company owns this namespace.
|
|
5971
6002
|
*/
|
|
5972
|
-
|
|
5973
|
-
|
|
5974
|
-
|
|
5975
|
-
|
|
5976
|
-
|
|
5977
|
-
reason?: CanceledReasonWithLiterals;
|
|
5978
|
-
}
|
|
5979
|
-
declare enum CanceledReason {
|
|
5980
|
-
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
5981
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
5982
|
-
/** Payment was not completed by user and expired. */
|
|
5983
|
-
EXPIRED = "EXPIRED"
|
|
5984
|
-
}
|
|
5985
|
-
/** @enumType */
|
|
5986
|
-
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
5987
|
-
interface DeclinedStatusDetails {
|
|
5988
|
-
reason?: DeclinedReasonWithLiterals;
|
|
5989
|
-
}
|
|
5990
|
-
declare enum DeclinedReason {
|
|
5991
|
-
/** Corresponding charge failed. */
|
|
5992
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5993
|
-
/** Payment details expired. */
|
|
5994
|
-
EXPIRED = "EXPIRED",
|
|
5995
|
-
/** Insufficient funds. */
|
|
5996
|
-
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
5997
|
-
/** Gift card was disabled before charge was attempted. */
|
|
5998
|
-
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5999
|
-
}
|
|
6000
|
-
/** @enumType */
|
|
6001
|
-
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6002
|
-
interface VoidedStatusDetails {
|
|
6003
|
-
reason?: VoidedReasonWithLiterals;
|
|
6004
|
-
}
|
|
6005
|
-
declare enum VoidedReason {
|
|
6006
|
-
/** Payment was voided by merchant request. */
|
|
6007
|
-
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
6008
|
-
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
6009
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
6010
|
-
}
|
|
6011
|
-
/** @enumType */
|
|
6012
|
-
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
6013
|
-
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
6014
|
-
}
|
|
6015
|
-
/** @oneof */
|
|
6016
|
-
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
6017
|
-
}
|
|
6018
|
-
interface Refund {
|
|
6003
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
6004
|
+
/** Codux Headless Sites */
|
|
6005
|
+
CODUX = "CODUX",
|
|
6006
|
+
/** Bobb - AI Design Creator. */
|
|
6007
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
6019
6008
|
/**
|
|
6020
|
-
*
|
|
6021
|
-
*
|
|
6022
|
-
* @readonly
|
|
6009
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
6010
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
6023
6011
|
*/
|
|
6024
|
-
|
|
6012
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
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",
|
|
6025
6029
|
/**
|
|
6026
|
-
*
|
|
6027
|
-
*
|
|
6030
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
6031
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
6028
6032
|
*/
|
|
6029
|
-
|
|
6030
|
-
/**
|
|
6031
|
-
|
|
6033
|
+
SYMPHONY = "SYMPHONY",
|
|
6034
|
+
/** Nautilus platform app. */
|
|
6035
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
6032
6036
|
/**
|
|
6033
|
-
*
|
|
6034
|
-
*
|
|
6035
|
-
* @immutable
|
|
6037
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
6038
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
6036
6039
|
*/
|
|
6037
|
-
|
|
6040
|
+
VIBU = "VIBU",
|
|
6038
6041
|
/**
|
|
6039
|
-
*
|
|
6040
|
-
*
|
|
6042
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
6043
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
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.
|
|
6041
6046
|
*/
|
|
6042
|
-
|
|
6047
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
6043
6048
|
/**
|
|
6044
|
-
*
|
|
6045
|
-
*
|
|
6046
|
-
* @readonly
|
|
6047
|
-
* @immutable
|
|
6049
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
6050
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
6048
6051
|
*/
|
|
6049
|
-
|
|
6052
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
6050
6053
|
}
|
|
6051
|
-
|
|
6054
|
+
/** @enumType */
|
|
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 {
|
|
6052
6058
|
/**
|
|
6053
|
-
*
|
|
6059
|
+
* A previous owner id (user that transfers meta site).
|
|
6054
6060
|
* @format GUID
|
|
6055
|
-
* @immutable
|
|
6056
6061
|
*/
|
|
6057
|
-
|
|
6062
|
+
oldOwnerId?: string;
|
|
6058
6063
|
/**
|
|
6059
|
-
*
|
|
6060
|
-
* @
|
|
6064
|
+
* A new owner id (user that accepts meta site).
|
|
6065
|
+
* @format GUID
|
|
6061
6066
|
*/
|
|
6062
|
-
|
|
6063
|
-
|
|
6064
|
-
|
|
6065
|
-
|
|
6066
|
-
|
|
6067
|
+
newOwnerId?: string;
|
|
6068
|
+
}
|
|
6069
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
6070
|
+
interface SiteDeleted {
|
|
6071
|
+
/** A deletion context. */
|
|
6072
|
+
deleteContext?: DeleteContext;
|
|
6073
|
+
}
|
|
6074
|
+
interface DeleteContext {
|
|
6075
|
+
/** When the meta site was deleted. */
|
|
6076
|
+
dateDeleted?: Date | null;
|
|
6077
|
+
/** A status. */
|
|
6078
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
6067
6079
|
/**
|
|
6068
|
-
*
|
|
6069
|
-
*
|
|
6070
|
-
* @format GUID
|
|
6080
|
+
* A reason (flow).
|
|
6081
|
+
* @maxLength 255
|
|
6071
6082
|
*/
|
|
6072
|
-
|
|
6073
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
6074
|
-
providerRefundId?: string | null;
|
|
6083
|
+
deleteOrigin?: string;
|
|
6075
6084
|
/**
|
|
6076
|
-
*
|
|
6077
|
-
* @
|
|
6085
|
+
* A service that deleted it.
|
|
6086
|
+
* @maxLength 255
|
|
6078
6087
|
*/
|
|
6079
|
-
|
|
6088
|
+
initiatorId?: string | null;
|
|
6080
6089
|
}
|
|
6081
|
-
|
|
6082
|
-
|
|
6083
|
-
|
|
6084
|
-
|
|
6085
|
-
|
|
6086
|
-
|
|
6087
|
-
/** Refund transaction failed. */
|
|
6088
|
-
FAILED = "FAILED",
|
|
6089
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
6090
|
-
SCHEDULED = "SCHEDULED",
|
|
6091
|
-
/** Refund was initiated on payment provider side. */
|
|
6092
|
-
STARTED = "STARTED"
|
|
6090
|
+
declare enum DeleteStatus {
|
|
6091
|
+
UNKNOWN = "UNKNOWN",
|
|
6092
|
+
TRASH = "TRASH",
|
|
6093
|
+
DELETED = "DELETED",
|
|
6094
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
6095
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
6093
6096
|
}
|
|
6094
6097
|
/** @enumType */
|
|
6095
|
-
type
|
|
6096
|
-
|
|
6097
|
-
|
|
6098
|
-
|
|
6099
|
-
|
|
6100
|
-
|
|
6101
|
-
|
|
6102
|
-
|
|
6103
|
-
*/
|
|
6104
|
-
paymentGatewayReasonCode?: string | null;
|
|
6098
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
6099
|
+
/** Restoration of the meta site. */
|
|
6100
|
+
interface SiteUndeleted {
|
|
6101
|
+
}
|
|
6102
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
6103
|
+
interface SitePublished {
|
|
6104
|
+
}
|
|
6105
|
+
interface SiteUnpublished {
|
|
6105
6106
|
/**
|
|
6106
|
-
*
|
|
6107
|
-
* @
|
|
6108
|
-
* @
|
|
6107
|
+
* A list of URLs previously associated with the meta site.
|
|
6108
|
+
* @maxLength 4000
|
|
6109
|
+
* @maxSize 10000
|
|
6109
6110
|
*/
|
|
6110
|
-
|
|
6111
|
+
urls?: string[];
|
|
6111
6112
|
}
|
|
6112
|
-
interface
|
|
6113
|
-
/** Total amount requested for refund. */
|
|
6114
|
-
requestedRefund?: Price;
|
|
6115
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
6116
|
-
pendingRefund?: Price;
|
|
6117
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
6118
|
-
refunded?: Price;
|
|
6119
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6120
|
-
failedRefundAmount?: Price;
|
|
6121
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6122
|
-
pending?: boolean;
|
|
6123
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6124
|
-
breakdown?: RefundItemsBreakdown;
|
|
6113
|
+
interface SiteMarkedAsTemplate {
|
|
6125
6114
|
}
|
|
6126
|
-
interface
|
|
6115
|
+
interface SiteMarkedAsWixSite {
|
|
6116
|
+
}
|
|
6117
|
+
/**
|
|
6118
|
+
* Represents a service provisioned a site.
|
|
6119
|
+
*
|
|
6120
|
+
* Note on `origin_instance_id`:
|
|
6121
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
6122
|
+
* This is because of the following scenario:
|
|
6123
|
+
*
|
|
6124
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
6125
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
6126
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
6127
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
6128
|
+
* your site remains consistent with what you initially received and does not include any
|
|
6129
|
+
* changes made to the original template afterward.
|
|
6130
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
6131
|
+
*/
|
|
6132
|
+
interface ServiceProvisioned {
|
|
6127
6133
|
/**
|
|
6128
|
-
*
|
|
6129
|
-
* @
|
|
6134
|
+
* Either UUID or EmbeddedServiceType.
|
|
6135
|
+
* @maxLength 36
|
|
6130
6136
|
*/
|
|
6131
|
-
|
|
6132
|
-
}
|
|
6133
|
-
interface LineItemRefundSummary {
|
|
6137
|
+
appDefId?: string;
|
|
6134
6138
|
/**
|
|
6135
|
-
*
|
|
6136
|
-
* @
|
|
6139
|
+
* Not only UUID. Something here could be something weird.
|
|
6140
|
+
* @maxLength 36
|
|
6137
6141
|
*/
|
|
6138
|
-
|
|
6139
|
-
/** Total refunded amount for the line item. */
|
|
6140
|
-
totalRefundedAmount?: Price;
|
|
6141
|
-
}
|
|
6142
|
-
interface CalculateRefundRequest {
|
|
6142
|
+
instanceId?: string;
|
|
6143
6143
|
/**
|
|
6144
|
-
*
|
|
6145
|
-
* @
|
|
6146
|
-
* @maxLength 100
|
|
6144
|
+
* An instance id from which this instance is originated.
|
|
6145
|
+
* @maxLength 36
|
|
6147
6146
|
*/
|
|
6148
|
-
|
|
6147
|
+
originInstanceId?: string;
|
|
6149
6148
|
/**
|
|
6150
|
-
*
|
|
6151
|
-
* @
|
|
6149
|
+
* A version.
|
|
6150
|
+
* @maxLength 500
|
|
6152
6151
|
*/
|
|
6153
|
-
|
|
6154
|
-
/** Should include shipping in refund calculation */
|
|
6155
|
-
refundShipping?: boolean;
|
|
6156
|
-
}
|
|
6157
|
-
interface CalculateRefundItemRequest {
|
|
6152
|
+
version?: string | null;
|
|
6158
6153
|
/**
|
|
6159
|
-
*
|
|
6154
|
+
* The origin meta site id
|
|
6160
6155
|
* @format GUID
|
|
6161
6156
|
*/
|
|
6162
|
-
|
|
6157
|
+
originMetaSiteId?: string | null;
|
|
6158
|
+
}
|
|
6159
|
+
interface ServiceRemoved {
|
|
6163
6160
|
/**
|
|
6164
|
-
*
|
|
6165
|
-
* @
|
|
6166
|
-
* @max 100000
|
|
6161
|
+
* Either UUID or EmbeddedServiceType.
|
|
6162
|
+
* @maxLength 36
|
|
6167
6163
|
*/
|
|
6168
|
-
|
|
6169
|
-
}
|
|
6170
|
-
interface CalculateRefundResponse {
|
|
6171
|
-
/** Total refundable amount */
|
|
6172
|
-
total?: Price;
|
|
6173
|
-
/** Tax cost of the order */
|
|
6174
|
-
tax?: Price;
|
|
6175
|
-
/** Discount given for this order */
|
|
6176
|
-
discount?: Price;
|
|
6177
|
-
/** Total cost of the order (without tax) */
|
|
6178
|
-
subtotal?: Price;
|
|
6179
|
-
/** Total shipping cost for order */
|
|
6180
|
-
shipping?: Price;
|
|
6181
|
-
/** Previous refund given on that order */
|
|
6182
|
-
previouslyRefundedAmount?: Price;
|
|
6164
|
+
appDefId?: string;
|
|
6183
6165
|
/**
|
|
6184
|
-
*
|
|
6185
|
-
* @
|
|
6166
|
+
* Not only UUID. Something here could be something weird.
|
|
6167
|
+
* @maxLength 36
|
|
6186
6168
|
*/
|
|
6187
|
-
|
|
6188
|
-
}
|
|
6189
|
-
interface CalculateRefundItemResponse {
|
|
6169
|
+
instanceId?: string;
|
|
6190
6170
|
/**
|
|
6191
|
-
*
|
|
6192
|
-
* @
|
|
6171
|
+
* A version.
|
|
6172
|
+
* @maxLength 500
|
|
6193
6173
|
*/
|
|
6194
|
-
|
|
6195
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6196
|
-
price?: Price;
|
|
6174
|
+
version?: string | null;
|
|
6197
6175
|
}
|
|
6198
|
-
|
|
6176
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
6177
|
+
interface SiteRenamed {
|
|
6199
6178
|
/**
|
|
6200
|
-
*
|
|
6201
|
-
* @
|
|
6202
|
-
* @maxLength 100
|
|
6179
|
+
* A new meta site name (URL slug).
|
|
6180
|
+
* @maxLength 20
|
|
6203
6181
|
*/
|
|
6204
|
-
|
|
6182
|
+
newSiteName?: string;
|
|
6205
6183
|
/**
|
|
6206
|
-
*
|
|
6207
|
-
* @
|
|
6208
|
-
* @maxSize 100
|
|
6209
|
-
* @format GUID
|
|
6184
|
+
* A previous meta site name (URL slug).
|
|
6185
|
+
* @maxLength 255
|
|
6210
6186
|
*/
|
|
6211
|
-
|
|
6187
|
+
oldSiteName?: string;
|
|
6212
6188
|
}
|
|
6213
|
-
|
|
6214
|
-
|
|
6215
|
-
|
|
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;
|
|
6216
6197
|
}
|
|
6217
|
-
interface
|
|
6218
|
-
/**
|
|
6219
|
-
|
|
6220
|
-
|
|
6221
|
-
|
|
6222
|
-
|
|
6223
|
-
|
|
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 {
|
|
6209
|
+
}
|
|
6210
|
+
/**
|
|
6211
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
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 {
|
|
6219
|
+
}
|
|
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 {
|
|
6224
6225
|
/**
|
|
6225
|
-
*
|
|
6226
|
-
* @minSize 1
|
|
6226
|
+
* @maxLength 2048
|
|
6227
6227
|
* @maxSize 100
|
|
6228
|
+
* @deprecated
|
|
6229
|
+
* @targetRemovalDate 2025-04-15
|
|
6228
6230
|
*/
|
|
6229
|
-
|
|
6231
|
+
appDefId?: string[];
|
|
6230
6232
|
}
|
|
6231
|
-
|
|
6232
|
-
|
|
6233
|
-
* Payment ID
|
|
6234
|
-
* @format GUID
|
|
6235
|
-
*/
|
|
6236
|
-
paymentId?: string | null;
|
|
6237
|
-
/**
|
|
6238
|
-
* Capture amount.
|
|
6239
|
-
* If not provided - full authorized amount will be captured.
|
|
6240
|
-
*/
|
|
6241
|
-
amount?: Price;
|
|
6233
|
+
/** Assigned Odeditor */
|
|
6234
|
+
interface OdeditorAssigned {
|
|
6242
6235
|
}
|
|
6243
|
-
|
|
6244
|
-
|
|
6245
|
-
orderTransactions?: OrderTransactions;
|
|
6236
|
+
/** Unassigned Odeditor */
|
|
6237
|
+
interface OdeditorUnassigned {
|
|
6246
6238
|
}
|
|
6247
|
-
|
|
6248
|
-
|
|
6249
|
-
* Ecom Order ID.
|
|
6250
|
-
* @minLength 1
|
|
6251
|
-
* @maxLength 100
|
|
6252
|
-
*/
|
|
6253
|
-
ecomOrderId?: string;
|
|
6254
|
-
/** Amount to be charged */
|
|
6255
|
-
amount?: Price;
|
|
6239
|
+
/** Assigned Picasso editor */
|
|
6240
|
+
interface PicassoAssigned {
|
|
6256
6241
|
}
|
|
6257
|
-
|
|
6258
|
-
|
|
6259
|
-
paymentGatewayOrderId?: string;
|
|
6242
|
+
/** Unassigned Picasso */
|
|
6243
|
+
interface PicassoUnassigned {
|
|
6260
6244
|
}
|
|
6261
|
-
|
|
6262
|
-
|
|
6263
|
-
metasiteId?: string;
|
|
6264
|
-
/**
|
|
6265
|
-
* @minLength 1
|
|
6266
|
-
* @maxLength 100
|
|
6267
|
-
* @maxSize 100
|
|
6268
|
-
*/
|
|
6269
|
-
orderIds?: string[];
|
|
6245
|
+
/** Assigned Wixel */
|
|
6246
|
+
interface WixelAssigned {
|
|
6270
6247
|
}
|
|
6271
|
-
|
|
6248
|
+
/** Unassigned Wixel */
|
|
6249
|
+
interface WixelUnassigned {
|
|
6272
6250
|
}
|
|
6273
|
-
|
|
6274
|
-
|
|
6275
|
-
|
|
6276
|
-
|
|
6277
|
-
|
|
6278
|
-
|
|
6279
|
-
|
|
6280
|
-
|
|
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 {
|
|
6268
|
+
}
|
|
6269
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
6270
|
+
}
|
|
6271
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
6272
|
+
hasCustomConfigurations?: boolean;
|
|
6273
|
+
}
|
|
6274
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
6275
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
6276
|
+
sendCustomEmailConfigs?: boolean;
|
|
6277
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
6278
|
+
origin?: OriginWithLiterals;
|
|
6279
|
+
}
|
|
6280
|
+
declare enum Origin {
|
|
6281
|
+
OPT_IN = "OPT_IN",
|
|
6282
|
+
MIGRATION = "MIGRATION"
|
|
6283
|
+
}
|
|
6284
|
+
/** @enumType */
|
|
6285
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
6286
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
6287
|
+
success?: boolean;
|
|
6288
|
+
}
|
|
6289
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
6290
|
+
}
|
|
6291
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
6292
|
+
inPopulation?: boolean;
|
|
6281
6293
|
}
|
|
6282
6294
|
interface DiffmatokyPayload {
|
|
6283
6295
|
left?: string;
|
|
@@ -8288,4 +8300,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
|
|
|
8288
8300
|
declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
|
|
8289
8301
|
declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
|
|
8290
8302
|
|
|
8291
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CrossBorderAdjustmentUpdate as CrossBorderAdjustmentUpdateOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricing as CrossBorderRepricingOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type PricesRecalculatedForDestination as PricesRecalculatedForDestinationOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|
|
8303
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type CouponDiscountValueOneOf as CouponDiscountValueOneOfOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CrossBorderAdjustmentUpdate as CrossBorderAdjustmentUpdateOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricing as CrossBorderRepricingOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleDiscountValueOneOf as DiscountRuleDiscountValueOneOfOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, DiscountValueType as DiscountValueTypeOriginal, type DiscountValueTypeWithLiterals as DiscountValueTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type PricesRecalculatedForDestination as PricesRecalculatedForDestinationOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|