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