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