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