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