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