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