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