@wix/auto_sdk_ecom_orders 1.0.252 → 1.0.254
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{ecom-v1-order-orders.universal-Cc8IUoG2.d.ts → ecom-v1-order-orders.universal-KHoi3OZ9.d.ts} +1589 -1581
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +82 -75
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +82 -75
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1590 -1582
- package/build/cjs/meta.js +82 -75
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-Cc8IUoG2.d.mts → ecom-v1-order-orders.universal-KHoi3OZ9.d.mts} +1589 -1581
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +81 -75
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +81 -75
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1590 -1582
- package/build/es/meta.mjs +81 -75
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-Cikj7dUx.d.ts → ecom-v1-order-orders.universal-BnQm5A1P.d.ts} +1650 -1637
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js +82 -75
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +82 -75
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1590 -1582
- package/build/internal/cjs/meta.js +82 -75
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{ecom-v1-order-orders.universal-Cikj7dUx.d.mts → ecom-v1-order-orders.universal-BnQm5A1P.d.mts} +1650 -1637
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs +81 -75
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +81 -75
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1590 -1582
- package/build/internal/es/meta.mjs +81 -75
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ed as ImportOrderRequest$1, I as ImportOrderResponse$1, ee as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ef as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fD as PreparePaymentCollectionRequest$1, d as PreparePaymentCollectionResponse$1, fH as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fI as RecordManuallyCollectedPaymentRequest$1, fL as RecordManuallyCollectedPaymentResponse$1, fM as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, fN as BulkMarkOrdersAsPaidRequest$1, i as BulkMarkOrdersAsPaidResponse$1, fS as GetRefundabilityStatusRequest$1, j as GetRefundabilityStatusResponse$1, fV as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, fX as ChargeMembershipsRequest$1, f$ as ChargeMembershipsResponse$1, g0 as TriggerRefundRequest$1, o as TriggerRefundResponse$1, gx as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gy as CaptureAuthorizedPaymentsRequest$1, s as CaptureAuthorizedPaymentsResponse$1, gD as GetOrderRequest$1, gE as GetOrderResponse$1, gQ as SearchOrdersRequest$1, w as SearchOrdersResponse$1, gU as CreateOrderRequest$1, gY as CreateOrderResponse$1, gZ as UpdateOrderRequest$1, g_ as UpdateOrderResponse$1, g$ as BulkUpdateOrdersRequest$1, E as BulkUpdateOrdersResponse$1, hu as UpdateOrderLineItemRequest$1, J as UpdateOrderLineItemResponse$1, hV as AddActivityRequest$1, L as AddActivityResponse$1, hX as AddActivitiesRequest$1, Q as AddActivitiesResponse$1, hY as UpdateActivityRequest$1, X as UpdateActivityResponse$1, hZ as DeleteActivityRequest$1, Z as DeleteActivityResponse$1, i3 as CancelOrderRequest$1, $ as CancelOrderResponse$1, i4 as UpdateOrderStatusRequest$1, a2 as UpdateOrderStatusResponse$1, iu as AggregateOrdersRequest$1, a5 as AggregateOrdersResponse$1, iy as BulkUpdateOrderTagsRequest$1, a7 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-BnQm5A1P.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -801,6 +801,14 @@ interface BillingSettings {
|
|
|
801
801
|
*/
|
|
802
802
|
anchorDay?: number | null;
|
|
803
803
|
}
|
|
804
|
+
declare enum ProductPeriodAlignment {
|
|
805
|
+
/** Billing period equals the product/service/subscription access period. */
|
|
806
|
+
ALIGNED_WITH_BILLING_PERIOD = "ALIGNED_WITH_BILLING_PERIOD",
|
|
807
|
+
/** Billing period is independent of the product/service/subscription access period. */
|
|
808
|
+
NOT_ALIGNED_WITH_BILLING_PERIOD = "NOT_ALIGNED_WITH_BILLING_PERIOD"
|
|
809
|
+
}
|
|
810
|
+
/** @enumType */
|
|
811
|
+
type ProductPeriodAlignmentWithLiterals = ProductPeriodAlignment | 'ALIGNED_WITH_BILLING_PERIOD' | 'NOT_ALIGNED_WITH_BILLING_PERIOD';
|
|
804
812
|
interface BillingAdjustment {
|
|
805
813
|
/** The type of adjustment. */
|
|
806
814
|
type?: AdjustmentTypeWithLiterals;
|
|
@@ -3783,450 +3791,163 @@ interface V1TriggerReindexOrderRequest {
|
|
|
3783
3791
|
*/
|
|
3784
3792
|
orderId?: string;
|
|
3785
3793
|
}
|
|
3786
|
-
interface
|
|
3794
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
3795
|
+
/** @format GUID */
|
|
3796
|
+
orderId?: string;
|
|
3797
|
+
}
|
|
3798
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
3799
|
+
}
|
|
3800
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3787
3801
|
/**
|
|
3788
|
-
* Ecom order ID.
|
|
3789
3802
|
* @minLength 1
|
|
3790
3803
|
* @maxLength 100
|
|
3791
3804
|
*/
|
|
3792
|
-
|
|
3793
|
-
/** Amount to collect */
|
|
3794
|
-
amount: Price;
|
|
3795
|
-
/**
|
|
3796
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
3797
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
3798
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
3799
|
-
*/
|
|
3800
|
-
paymentGatewayOrderId?: string | null;
|
|
3801
|
-
/**
|
|
3802
|
-
* Whether to delay capture of the payment.
|
|
3803
|
-
* Default: false
|
|
3804
|
-
* @deprecated Whether to delay capture of the payment.
|
|
3805
|
-
* Default: false
|
|
3806
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
3807
|
-
* @targetRemovalDate 2024-09-30
|
|
3808
|
-
*/
|
|
3809
|
-
delayedCapture?: boolean;
|
|
3810
|
-
/** Delayed capture payment settings */
|
|
3811
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
3805
|
+
orderId?: string;
|
|
3812
3806
|
}
|
|
3813
|
-
interface
|
|
3814
|
-
|
|
3815
|
-
|
|
3816
|
-
* @format WEB_URL
|
|
3817
|
-
*/
|
|
3818
|
-
successUrl?: string | null;
|
|
3807
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3808
|
+
}
|
|
3809
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3819
3810
|
/**
|
|
3820
|
-
*
|
|
3821
|
-
* @
|
|
3811
|
+
* @minLength 1
|
|
3812
|
+
* @maxLength 100
|
|
3822
3813
|
*/
|
|
3823
|
-
|
|
3814
|
+
orderId?: string;
|
|
3815
|
+
}
|
|
3816
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3817
|
+
}
|
|
3818
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3824
3819
|
/**
|
|
3825
|
-
*
|
|
3826
|
-
* @
|
|
3820
|
+
* IDs of orders to send pickup emails for.
|
|
3821
|
+
* @minSize 1
|
|
3822
|
+
* @maxSize 300
|
|
3827
3823
|
*/
|
|
3828
|
-
|
|
3824
|
+
orderIds?: string[];
|
|
3825
|
+
}
|
|
3826
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3827
|
+
}
|
|
3828
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3829
3829
|
/**
|
|
3830
|
-
*
|
|
3831
|
-
* @
|
|
3830
|
+
* @minLength 1
|
|
3831
|
+
* @maxLength 100
|
|
3832
3832
|
*/
|
|
3833
|
-
|
|
3834
|
-
}
|
|
3835
|
-
interface DelayedCaptureSettings {
|
|
3836
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
3837
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
3838
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
3839
|
-
delayDuration?: Duration;
|
|
3833
|
+
orderId?: string;
|
|
3840
3834
|
}
|
|
3841
|
-
|
|
3842
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
3843
|
-
VOID = "VOID",
|
|
3844
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
3845
|
-
CAPTURE = "CAPTURE"
|
|
3835
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3846
3836
|
}
|
|
3847
|
-
|
|
3848
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
3849
|
-
interface Duration {
|
|
3837
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3850
3838
|
/**
|
|
3851
|
-
*
|
|
3852
|
-
* @
|
|
3839
|
+
* IDs of orders to send pickup emails for.
|
|
3840
|
+
* @minSize 1
|
|
3841
|
+
* @maxSize 300
|
|
3853
3842
|
*/
|
|
3854
|
-
|
|
3855
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
3856
|
-
unit?: DurationUnitWithLiterals;
|
|
3857
|
-
}
|
|
3858
|
-
declare enum DurationUnit {
|
|
3859
|
-
MINUTES = "MINUTES",
|
|
3860
|
-
HOURS = "HOURS",
|
|
3861
|
-
DAYS = "DAYS"
|
|
3843
|
+
orderIds?: string[];
|
|
3862
3844
|
}
|
|
3863
|
-
|
|
3864
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
3865
|
-
interface PreparePaymentCollectionResponse {
|
|
3866
|
-
/** Payment gateway order id which is associated with given payment */
|
|
3867
|
-
paymentGatewayOrderId?: string;
|
|
3845
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3868
3846
|
}
|
|
3869
|
-
interface
|
|
3847
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3870
3848
|
/**
|
|
3871
|
-
* Ecom order ID.
|
|
3872
3849
|
* @minLength 1
|
|
3873
3850
|
* @maxLength 100
|
|
3874
3851
|
*/
|
|
3875
|
-
|
|
3876
|
-
}
|
|
3877
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
3878
|
-
/** Payment collectability status */
|
|
3879
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
3880
|
-
/** Collectable order amount */
|
|
3881
|
-
amount?: Price;
|
|
3852
|
+
orderId?: string;
|
|
3882
3853
|
}
|
|
3883
|
-
|
|
3884
|
-
UNKNOWN = "UNKNOWN",
|
|
3885
|
-
COLLECTABLE = "COLLECTABLE",
|
|
3886
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
3887
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
3888
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
3889
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
3890
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
3891
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
3892
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
3893
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
3894
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
3895
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
3854
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
3896
3855
|
}
|
|
3897
|
-
|
|
3898
|
-
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED';
|
|
3899
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
3856
|
+
interface SendCancelRefundEmailRequest {
|
|
3900
3857
|
/**
|
|
3901
|
-
*
|
|
3858
|
+
* The ID of order that is canceled/refunded
|
|
3902
3859
|
* @minLength 1
|
|
3903
3860
|
* @maxLength 100
|
|
3904
3861
|
*/
|
|
3905
|
-
orderId
|
|
3906
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
3907
|
-
amount: Price;
|
|
3908
|
-
}
|
|
3909
|
-
/**
|
|
3910
|
-
* User-defined payment method name.
|
|
3911
|
-
* Allows specifying either a predefined type or a custom name.
|
|
3912
|
-
*/
|
|
3913
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
3914
|
-
/** Predefined payment method. */
|
|
3915
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
3862
|
+
orderId?: string;
|
|
3916
3863
|
/**
|
|
3917
|
-
*
|
|
3918
|
-
*
|
|
3919
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
3864
|
+
* Personal note added to the email (optional)
|
|
3920
3865
|
* @minLength 1
|
|
3921
|
-
* @maxLength
|
|
3866
|
+
* @maxLength 1000
|
|
3922
3867
|
*/
|
|
3923
|
-
|
|
3868
|
+
customMessage?: string | null;
|
|
3869
|
+
/** Refund amount */
|
|
3870
|
+
refundAmount?: Price;
|
|
3871
|
+
/**
|
|
3872
|
+
* Refund ID. (Optional)
|
|
3873
|
+
* @format GUID
|
|
3874
|
+
*/
|
|
3875
|
+
refundId?: string | null;
|
|
3924
3876
|
}
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
3877
|
+
interface SendCancelRefundEmailResponse {
|
|
3878
|
+
}
|
|
3879
|
+
interface SendRefundEmailRequest {
|
|
3929
3880
|
/**
|
|
3930
|
-
*
|
|
3931
|
-
*
|
|
3932
|
-
|
|
3881
|
+
* The ID of order that is refunded
|
|
3882
|
+
* @format GUID
|
|
3883
|
+
*/
|
|
3884
|
+
orderId?: string;
|
|
3885
|
+
/**
|
|
3886
|
+
* Refund ID
|
|
3887
|
+
* @format GUID
|
|
3888
|
+
*/
|
|
3889
|
+
refundId?: string;
|
|
3890
|
+
/**
|
|
3891
|
+
* Personal note added to the email (optional)
|
|
3933
3892
|
* @minLength 1
|
|
3934
|
-
* @maxLength
|
|
3893
|
+
* @maxLength 1000
|
|
3935
3894
|
*/
|
|
3936
|
-
|
|
3895
|
+
customMessage?: string | null;
|
|
3937
3896
|
}
|
|
3938
|
-
|
|
3939
|
-
declare enum PredefinedPaymentMethod {
|
|
3940
|
-
/** Cash payment. */
|
|
3941
|
-
CASH = "CASH",
|
|
3942
|
-
/** Bank transfer. */
|
|
3943
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
3944
|
-
/** Payment by check. */
|
|
3945
|
-
CHECK = "CHECK"
|
|
3897
|
+
interface SendRefundEmailResponse {
|
|
3946
3898
|
}
|
|
3947
|
-
|
|
3948
|
-
|
|
3949
|
-
|
|
3899
|
+
interface SendFulfillmentEmailRequest {
|
|
3900
|
+
/** @format GUID */
|
|
3901
|
+
orderId?: string;
|
|
3902
|
+
/** @format GUID */
|
|
3903
|
+
fulfillerId?: string;
|
|
3950
3904
|
}
|
|
3951
|
-
interface
|
|
3905
|
+
interface SendFulfillmentEmailResponse {
|
|
3906
|
+
}
|
|
3907
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
3952
3908
|
/**
|
|
3953
|
-
* Ecom order ID.
|
|
3954
3909
|
* @minLength 1
|
|
3955
3910
|
* @maxLength 100
|
|
3956
3911
|
*/
|
|
3957
|
-
|
|
3912
|
+
orderId?: string;
|
|
3958
3913
|
}
|
|
3959
|
-
interface
|
|
3960
|
-
/** Updated order. */
|
|
3961
|
-
order?: Order;
|
|
3914
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
3962
3915
|
}
|
|
3963
|
-
interface
|
|
3916
|
+
interface PreviewEmailByTypeRequest {
|
|
3917
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
3918
|
+
}
|
|
3919
|
+
declare enum PreviewEmailType {
|
|
3920
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
3921
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
3922
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3923
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
3924
|
+
}
|
|
3925
|
+
/** @enumType */
|
|
3926
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
3927
|
+
interface PreviewEmailByTypeResponse {
|
|
3928
|
+
emailPreview?: string;
|
|
3929
|
+
}
|
|
3930
|
+
interface PreviewRefundEmailRequest {
|
|
3964
3931
|
/**
|
|
3965
|
-
* IDs of orders to mark as paid.
|
|
3966
|
-
* @minSize 1
|
|
3967
|
-
* @maxSize 100
|
|
3968
3932
|
* @minLength 1
|
|
3969
3933
|
* @maxLength 100
|
|
3970
3934
|
*/
|
|
3971
|
-
|
|
3972
|
-
|
|
3973
|
-
|
|
3935
|
+
orderId?: string;
|
|
3936
|
+
/** Refund amount */
|
|
3937
|
+
refundAmount?: Price;
|
|
3938
|
+
/** Refund business details */
|
|
3939
|
+
details?: RefundDetails;
|
|
3974
3940
|
/**
|
|
3975
|
-
*
|
|
3976
|
-
*
|
|
3941
|
+
* Personal note added to the email (optional)
|
|
3942
|
+
* @minLength 1
|
|
3943
|
+
* @maxLength 1000
|
|
3977
3944
|
*/
|
|
3978
|
-
|
|
3979
|
-
/** Bulk action metadata. */
|
|
3980
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
3981
|
-
}
|
|
3982
|
-
interface BulkOrderResult {
|
|
3983
|
-
/** Item metadata. */
|
|
3984
|
-
itemMetadata?: ItemMetadata;
|
|
3945
|
+
customMessage?: string | null;
|
|
3985
3946
|
/**
|
|
3986
|
-
*
|
|
3987
|
-
*
|
|
3988
|
-
* Returned when `returnFullEntity = true`.
|
|
3989
|
-
*/
|
|
3990
|
-
item?: Order;
|
|
3991
|
-
}
|
|
3992
|
-
interface ItemMetadata {
|
|
3993
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
3994
|
-
id?: string | null;
|
|
3995
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3996
|
-
originalIndex?: number;
|
|
3997
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
3998
|
-
success?: boolean;
|
|
3999
|
-
/** Details about the error in case of failure. */
|
|
4000
|
-
error?: ApplicationError;
|
|
4001
|
-
}
|
|
4002
|
-
interface ApplicationError {
|
|
4003
|
-
/** Error code. */
|
|
4004
|
-
code?: string;
|
|
4005
|
-
/** Description of the error. */
|
|
4006
|
-
description?: string;
|
|
4007
|
-
/** Data related to the error. */
|
|
4008
|
-
data?: Record<string, any> | null;
|
|
4009
|
-
}
|
|
4010
|
-
interface BulkActionMetadata {
|
|
4011
|
-
/** Number of items that were successfully processed. */
|
|
4012
|
-
totalSuccesses?: number;
|
|
4013
|
-
/** Number of items that couldn't be processed. */
|
|
4014
|
-
totalFailures?: number;
|
|
4015
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4016
|
-
undetailedFailures?: number;
|
|
4017
|
-
}
|
|
4018
|
-
interface GetRefundabilityStatusRequest {
|
|
4019
|
-
/**
|
|
4020
|
-
* Order ID.
|
|
4021
|
-
* @minLength 1
|
|
4022
|
-
* @maxLength 100
|
|
4023
|
-
*/
|
|
4024
|
-
ecomOrderId: string;
|
|
4025
|
-
}
|
|
4026
|
-
interface GetRefundabilityStatusResponse {
|
|
4027
|
-
/**
|
|
4028
|
-
* Refundability details.
|
|
4029
|
-
* @maxSize 300
|
|
4030
|
-
*/
|
|
4031
|
-
refundabilities?: Refundability[];
|
|
4032
|
-
/**
|
|
4033
|
-
* Whether the order supports refunding per item.
|
|
4034
|
-
* @deprecated
|
|
4035
|
-
*/
|
|
4036
|
-
refundablePerItem?: boolean;
|
|
4037
|
-
}
|
|
4038
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4039
|
-
/** Reason why payment is not refundable. */
|
|
4040
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4041
|
-
/** Reason why payment is only refundable manually. */
|
|
4042
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4043
|
-
/** Payment ID. */
|
|
4044
|
-
paymentId?: string;
|
|
4045
|
-
/** Payment refundability status. */
|
|
4046
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4047
|
-
/** Link to payment provider dashboard. */
|
|
4048
|
-
providerLink?: string | null;
|
|
4049
|
-
}
|
|
4050
|
-
/** @oneof */
|
|
4051
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4052
|
-
/** Reason why payment is not refundable. */
|
|
4053
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4054
|
-
/** Reason why payment is only refundable manually. */
|
|
4055
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4056
|
-
}
|
|
4057
|
-
declare enum RefundableStatus {
|
|
4058
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4059
|
-
MANUAL = "MANUAL",
|
|
4060
|
-
REFUNDABLE = "REFUNDABLE"
|
|
4061
|
-
}
|
|
4062
|
-
/** @enumType */
|
|
4063
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4064
|
-
declare enum NonRefundableReason {
|
|
4065
|
-
NONE = "NONE",
|
|
4066
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4067
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4068
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4069
|
-
NOT_PAID = "NOT_PAID",
|
|
4070
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4071
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
4072
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4073
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
4074
|
-
FORBIDDEN = "FORBIDDEN",
|
|
4075
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4076
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4077
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4078
|
-
}
|
|
4079
|
-
/** @enumType */
|
|
4080
|
-
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';
|
|
4081
|
-
declare enum ManuallyRefundableReason {
|
|
4082
|
-
EXPIRED = "EXPIRED",
|
|
4083
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4084
|
-
OFFLINE = "OFFLINE",
|
|
4085
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4086
|
-
}
|
|
4087
|
-
/** @enumType */
|
|
4088
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4089
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
4090
|
-
/**
|
|
4091
|
-
* Ecom order ID.
|
|
4092
|
-
* @minLength 1
|
|
4093
|
-
* @maxLength 100
|
|
4094
|
-
*/
|
|
4095
|
-
ecomOrderId: string;
|
|
4096
|
-
/** Information about the user who initiated the payment. */
|
|
4097
|
-
chargedBy?: ChargedBy;
|
|
4098
|
-
}
|
|
4099
|
-
interface ChargedBy {
|
|
4100
|
-
/**
|
|
4101
|
-
* ID - id of the user who initiated the payment
|
|
4102
|
-
* @format GUID
|
|
4103
|
-
*/
|
|
4104
|
-
id?: string;
|
|
4105
|
-
/**
|
|
4106
|
-
* Full name - name of the user who initiated the payment
|
|
4107
|
-
* @minLength 1
|
|
4108
|
-
* @maxLength 200
|
|
4109
|
-
*/
|
|
4110
|
-
fullName?: string | null;
|
|
4111
|
-
}
|
|
4112
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
4113
|
-
/** ID of the order created in the payment gateway */
|
|
4114
|
-
paymentGatewayOrderId?: string;
|
|
4115
|
-
}
|
|
4116
|
-
interface ChargeMembershipsRequest {
|
|
4117
|
-
/**
|
|
4118
|
-
* Order ID.
|
|
4119
|
-
* @minLength 1
|
|
4120
|
-
* @maxLength 100
|
|
4121
|
-
*/
|
|
4122
|
-
ecomOrderId: string;
|
|
4123
|
-
/**
|
|
4124
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4125
|
-
* but a user which is using the membership on behalf of the a member
|
|
4126
|
-
* @format GUID
|
|
4127
|
-
*/
|
|
4128
|
-
memberId: string;
|
|
4129
|
-
/**
|
|
4130
|
-
* List of items to be paid by memberships
|
|
4131
|
-
* @minSize 1
|
|
4132
|
-
* @maxSize 300
|
|
4133
|
-
*/
|
|
4134
|
-
membershipCharges?: MembershipChargeItem[];
|
|
4135
|
-
}
|
|
4136
|
-
interface MembershipChargeItem {
|
|
4137
|
-
/**
|
|
4138
|
-
* The id of used membership
|
|
4139
|
-
* @minLength 1
|
|
4140
|
-
* @maxLength 100
|
|
4141
|
-
*/
|
|
4142
|
-
membershipId?: string;
|
|
4143
|
-
/**
|
|
4144
|
-
* ID of the application providing this payment option
|
|
4145
|
-
* @format GUID
|
|
4146
|
-
*/
|
|
4147
|
-
appId?: string;
|
|
4148
|
-
/** The name of used membership */
|
|
4149
|
-
membershipName?: MembershipName;
|
|
4150
|
-
/** Additional data about this membership */
|
|
4151
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
4152
|
-
/** Catalog and item reference info. */
|
|
4153
|
-
catalogReference?: CatalogReference;
|
|
4154
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4155
|
-
serviceProperties?: ServiceProperties;
|
|
4156
|
-
/**
|
|
4157
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
4158
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4159
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4160
|
-
* @minLength 1
|
|
4161
|
-
* @maxLength 36
|
|
4162
|
-
*/
|
|
4163
|
-
rootCatalogItemId?: string | null;
|
|
4164
|
-
/**
|
|
4165
|
-
* line item id of Checkout/Order line item
|
|
4166
|
-
* @minLength 1
|
|
4167
|
-
* @maxLength 100
|
|
4168
|
-
*/
|
|
4169
|
-
lineItemId?: string;
|
|
4170
|
-
}
|
|
4171
|
-
interface MembershipName {
|
|
4172
|
-
/**
|
|
4173
|
-
* Membership name.
|
|
4174
|
-
* @maxLength 100
|
|
4175
|
-
*/
|
|
4176
|
-
original?: string;
|
|
4177
|
-
/**
|
|
4178
|
-
* Translated membership name. Defaults to `original` when not provided.
|
|
4179
|
-
* @maxLength 100
|
|
4180
|
-
*/
|
|
4181
|
-
translated?: string | null;
|
|
4182
|
-
}
|
|
4183
|
-
interface ServiceProperties {
|
|
4184
|
-
/**
|
|
4185
|
-
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
4186
|
-
* For example, the start time of a class.
|
|
4187
|
-
*/
|
|
4188
|
-
scheduledDate?: Date | null;
|
|
4189
|
-
/**
|
|
4190
|
-
* The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
|
|
4191
|
-
* @min 1
|
|
4192
|
-
* @max 10000
|
|
4193
|
-
*/
|
|
4194
|
-
numberOfParticipants?: number | null;
|
|
4195
|
-
}
|
|
4196
|
-
interface ChargeMembershipsResponse {
|
|
4197
|
-
}
|
|
4198
|
-
interface TriggerRefundRequest {
|
|
4199
|
-
/**
|
|
4200
|
-
* The order this refund related to
|
|
4201
|
-
* @minLength 1
|
|
4202
|
-
* @maxLength 100
|
|
4203
|
-
*/
|
|
4204
|
-
ecomOrderId: string;
|
|
4205
|
-
/**
|
|
4206
|
-
* Refund operations information
|
|
4207
|
-
* @minSize 1
|
|
4208
|
-
* @maxSize 1
|
|
4209
|
-
*/
|
|
4210
|
-
payments: PaymentRefund[];
|
|
4211
|
-
/** Business model of a refund */
|
|
4212
|
-
details?: RefundDetails;
|
|
4213
|
-
/** Side effect details related to refund */
|
|
4214
|
-
sideEffects?: RefundSideEffects;
|
|
4215
|
-
}
|
|
4216
|
-
interface PaymentRefund {
|
|
4217
|
-
/**
|
|
4218
|
-
* Specific payment within the order to refund
|
|
3947
|
+
* Refund ID. (Optional)
|
|
4219
3948
|
* @format GUID
|
|
4220
3949
|
*/
|
|
4221
|
-
|
|
4222
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
4223
|
-
amount?: Price;
|
|
4224
|
-
/**
|
|
4225
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
4226
|
-
* When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
|
|
4227
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
4228
|
-
*/
|
|
4229
|
-
externalRefund?: boolean;
|
|
3950
|
+
refundId?: string | null;
|
|
4230
3951
|
}
|
|
4231
3952
|
/** Business model of a refund request */
|
|
4232
3953
|
interface RefundDetails {
|
|
@@ -4303,1490 +4024,1777 @@ interface ShippingRefund {
|
|
|
4303
4024
|
*/
|
|
4304
4025
|
amount?: Price;
|
|
4305
4026
|
}
|
|
4306
|
-
interface
|
|
4307
|
-
|
|
4308
|
-
|
|
4309
|
-
|
|
4310
|
-
sendOrderRefundedEmail?: boolean;
|
|
4027
|
+
interface PreviewRefundEmailResponse {
|
|
4028
|
+
emailPreview?: string;
|
|
4029
|
+
}
|
|
4030
|
+
interface PreviewCancelEmailRequest {
|
|
4311
4031
|
/**
|
|
4312
|
-
* Custom message added to the refund confirmation email.
|
|
4313
4032
|
* @minLength 1
|
|
4314
|
-
* @maxLength
|
|
4033
|
+
* @maxLength 100
|
|
4315
4034
|
*/
|
|
4316
|
-
|
|
4035
|
+
orderId?: string;
|
|
4036
|
+
/**
|
|
4037
|
+
* Personal note added to the email (optional)
|
|
4038
|
+
* @minLength 1
|
|
4039
|
+
* @maxLength 1000
|
|
4040
|
+
*/
|
|
4041
|
+
customMessage?: string | null;
|
|
4042
|
+
}
|
|
4043
|
+
interface PreviewCancelEmailResponse {
|
|
4044
|
+
emailPreview?: string;
|
|
4045
|
+
}
|
|
4046
|
+
interface PreviewCancelRefundEmailRequest {
|
|
4047
|
+
/**
|
|
4048
|
+
* @minLength 1
|
|
4049
|
+
* @maxLength 100
|
|
4050
|
+
*/
|
|
4051
|
+
orderId?: string;
|
|
4052
|
+
/**
|
|
4053
|
+
* Personal note added to the email (optional)
|
|
4054
|
+
* @minLength 1
|
|
4055
|
+
* @maxLength 1000
|
|
4056
|
+
*/
|
|
4057
|
+
customMessage?: string | null;
|
|
4058
|
+
/** Refund amount */
|
|
4059
|
+
refundAmount?: Price;
|
|
4060
|
+
/**
|
|
4061
|
+
* Refund ID. (Optional)
|
|
4062
|
+
* @format GUID
|
|
4063
|
+
*/
|
|
4064
|
+
refundId?: string | null;
|
|
4065
|
+
}
|
|
4066
|
+
interface PreviewCancelRefundEmailResponse {
|
|
4067
|
+
emailPreview?: string;
|
|
4068
|
+
}
|
|
4069
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
4070
|
+
}
|
|
4071
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4072
|
+
emailPreview?: string;
|
|
4073
|
+
}
|
|
4074
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
4075
|
+
}
|
|
4076
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
4077
|
+
emailPreview?: string;
|
|
4078
|
+
}
|
|
4079
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4080
|
+
}
|
|
4081
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4082
|
+
emailPreview?: string;
|
|
4083
|
+
}
|
|
4084
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
4085
|
+
}
|
|
4086
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
4087
|
+
emailPreview?: string;
|
|
4088
|
+
}
|
|
4089
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
4090
|
+
}
|
|
4091
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
4092
|
+
emailPreview?: string;
|
|
4093
|
+
}
|
|
4094
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4095
|
+
/** Emitted on a meta site creation. */
|
|
4096
|
+
siteCreated?: SiteCreated;
|
|
4097
|
+
/** Emitted on a meta site transfer completion. */
|
|
4098
|
+
siteTransferred?: SiteTransferred;
|
|
4099
|
+
/** Emitted on a meta site deletion. */
|
|
4100
|
+
siteDeleted?: SiteDeleted;
|
|
4101
|
+
/** Emitted on a meta site restoration. */
|
|
4102
|
+
siteUndeleted?: SiteUndeleted;
|
|
4103
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4104
|
+
sitePublished?: SitePublished;
|
|
4105
|
+
/** Emitted on a meta site unpublish. */
|
|
4106
|
+
siteUnpublished?: SiteUnpublished;
|
|
4107
|
+
/** Emitted when meta site is marked as template. */
|
|
4108
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4109
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4110
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4111
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4112
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4113
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4114
|
+
serviceRemoved?: ServiceRemoved;
|
|
4115
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4116
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4117
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4118
|
+
hardDeleted?: SiteHardDeleted;
|
|
4119
|
+
/** Emitted on a namespace change. */
|
|
4120
|
+
namespaceChanged?: NamespaceChanged;
|
|
4121
|
+
/** Emitted when Studio is attached. */
|
|
4122
|
+
studioAssigned?: StudioAssigned;
|
|
4123
|
+
/** Emitted when Studio is detached. */
|
|
4124
|
+
studioUnassigned?: StudioUnassigned;
|
|
4125
|
+
/**
|
|
4126
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4127
|
+
* the actual URL.
|
|
4128
|
+
*
|
|
4129
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4130
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4131
|
+
*/
|
|
4132
|
+
urlChanged?: SiteUrlChanged;
|
|
4133
|
+
/** Site is marked as PurgedExternally */
|
|
4134
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4135
|
+
/** Emitted when Odeditor is attached. */
|
|
4136
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4137
|
+
/** Emitted when Odeditor is detached. */
|
|
4138
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4139
|
+
/** Emitted when Picasso is attached. */
|
|
4140
|
+
picassoAssigned?: PicassoAssigned;
|
|
4141
|
+
/** Emitted when Picasso is detached. */
|
|
4142
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4143
|
+
/** Emitted when Wixel is attached. */
|
|
4144
|
+
wixelAssigned?: WixelAssigned;
|
|
4145
|
+
/** Emitted when Wixel is detached. */
|
|
4146
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4147
|
+
/** Emitted when StudioTwo is attached. */
|
|
4148
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4149
|
+
/** Emitted when StudioTwo is detached. */
|
|
4150
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4151
|
+
/** Emitted when media from user domain is enabled. */
|
|
4152
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4153
|
+
/** Emitted when media from user domain is disabled. */
|
|
4154
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4155
|
+
/** Emitted when Editorless is attached. */
|
|
4156
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4157
|
+
/** Emitted when Editorless is detached. */
|
|
4158
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4159
|
+
/**
|
|
4160
|
+
* A meta site id.
|
|
4161
|
+
* @format GUID
|
|
4162
|
+
*/
|
|
4163
|
+
metaSiteId?: string;
|
|
4164
|
+
/** A meta site version. Monotonically increasing. */
|
|
4165
|
+
version?: string;
|
|
4166
|
+
/** A timestamp of the event. */
|
|
4167
|
+
timestamp?: string;
|
|
4168
|
+
/**
|
|
4169
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4170
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4171
|
+
* @maxSize 4000
|
|
4172
|
+
*/
|
|
4173
|
+
assets?: Asset[];
|
|
4174
|
+
}
|
|
4175
|
+
/** @oneof */
|
|
4176
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4177
|
+
/** Emitted on a meta site creation. */
|
|
4178
|
+
siteCreated?: SiteCreated;
|
|
4179
|
+
/** Emitted on a meta site transfer completion. */
|
|
4180
|
+
siteTransferred?: SiteTransferred;
|
|
4181
|
+
/** Emitted on a meta site deletion. */
|
|
4182
|
+
siteDeleted?: SiteDeleted;
|
|
4183
|
+
/** Emitted on a meta site restoration. */
|
|
4184
|
+
siteUndeleted?: SiteUndeleted;
|
|
4185
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4186
|
+
sitePublished?: SitePublished;
|
|
4187
|
+
/** Emitted on a meta site unpublish. */
|
|
4188
|
+
siteUnpublished?: SiteUnpublished;
|
|
4189
|
+
/** Emitted when meta site is marked as template. */
|
|
4190
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4191
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4192
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4193
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4194
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4195
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4196
|
+
serviceRemoved?: ServiceRemoved;
|
|
4197
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4198
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4199
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4200
|
+
hardDeleted?: SiteHardDeleted;
|
|
4201
|
+
/** Emitted on a namespace change. */
|
|
4202
|
+
namespaceChanged?: NamespaceChanged;
|
|
4203
|
+
/** Emitted when Studio is attached. */
|
|
4204
|
+
studioAssigned?: StudioAssigned;
|
|
4205
|
+
/** Emitted when Studio is detached. */
|
|
4206
|
+
studioUnassigned?: StudioUnassigned;
|
|
4207
|
+
/**
|
|
4208
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4209
|
+
* the actual URL.
|
|
4210
|
+
*
|
|
4211
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4212
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4213
|
+
*/
|
|
4214
|
+
urlChanged?: SiteUrlChanged;
|
|
4215
|
+
/** Site is marked as PurgedExternally */
|
|
4216
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4217
|
+
/** Emitted when Odeditor is attached. */
|
|
4218
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4219
|
+
/** Emitted when Odeditor is detached. */
|
|
4220
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4221
|
+
/** Emitted when Picasso is attached. */
|
|
4222
|
+
picassoAssigned?: PicassoAssigned;
|
|
4223
|
+
/** Emitted when Picasso is detached. */
|
|
4224
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4225
|
+
/** Emitted when Wixel is attached. */
|
|
4226
|
+
wixelAssigned?: WixelAssigned;
|
|
4227
|
+
/** Emitted when Wixel is detached. */
|
|
4228
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4229
|
+
/** Emitted when StudioTwo is attached. */
|
|
4230
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4231
|
+
/** Emitted when StudioTwo is detached. */
|
|
4232
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4233
|
+
/** Emitted when media from user domain is enabled. */
|
|
4234
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4235
|
+
/** Emitted when media from user domain is disabled. */
|
|
4236
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4237
|
+
/** Emitted when Editorless is attached. */
|
|
4238
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4239
|
+
/** Emitted when Editorless is detached. */
|
|
4240
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4241
|
+
}
|
|
4242
|
+
interface Asset {
|
|
4243
|
+
/**
|
|
4244
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4245
|
+
* @maxLength 36
|
|
4246
|
+
*/
|
|
4247
|
+
appDefId?: string;
|
|
4248
|
+
/**
|
|
4249
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
4250
|
+
* @maxLength 200
|
|
4251
|
+
*/
|
|
4252
|
+
instanceId?: string;
|
|
4253
|
+
/** An application state. */
|
|
4254
|
+
state?: StateWithLiterals;
|
|
4255
|
+
}
|
|
4256
|
+
declare enum State {
|
|
4257
|
+
UNKNOWN = "UNKNOWN",
|
|
4258
|
+
ENABLED = "ENABLED",
|
|
4259
|
+
DISABLED = "DISABLED",
|
|
4260
|
+
PENDING = "PENDING",
|
|
4261
|
+
DEMO = "DEMO"
|
|
4262
|
+
}
|
|
4263
|
+
/** @enumType */
|
|
4264
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
4265
|
+
interface SiteCreated {
|
|
4266
|
+
/**
|
|
4267
|
+
* A template identifier (empty if not created from a template).
|
|
4268
|
+
* @maxLength 36
|
|
4269
|
+
*/
|
|
4270
|
+
originTemplateId?: string;
|
|
4271
|
+
/**
|
|
4272
|
+
* An account id of the owner.
|
|
4273
|
+
* @format GUID
|
|
4274
|
+
*/
|
|
4275
|
+
ownerId?: string;
|
|
4276
|
+
/** A context in which meta site was created. */
|
|
4277
|
+
context?: SiteCreatedContextWithLiterals;
|
|
4278
|
+
/**
|
|
4279
|
+
* A meta site id from which this site was created.
|
|
4280
|
+
*
|
|
4281
|
+
* In case of a creation from a template it's a template id.
|
|
4282
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4283
|
+
* @format GUID
|
|
4284
|
+
*/
|
|
4285
|
+
originMetaSiteId?: string | null;
|
|
4286
|
+
/**
|
|
4287
|
+
* A meta site name (URL slug).
|
|
4288
|
+
* @maxLength 20
|
|
4289
|
+
*/
|
|
4290
|
+
siteName?: string;
|
|
4291
|
+
/** A namespace. */
|
|
4292
|
+
namespace?: NamespaceWithLiterals;
|
|
4293
|
+
}
|
|
4294
|
+
declare enum SiteCreatedContext {
|
|
4295
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4296
|
+
OTHER = "OTHER",
|
|
4297
|
+
/** A meta site was created from template. */
|
|
4298
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4299
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
4300
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4301
|
+
/** A copy of existing meta site. */
|
|
4302
|
+
DUPLICATE = "DUPLICATE",
|
|
4303
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4304
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4305
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
4306
|
+
FLASH = "FLASH"
|
|
4307
|
+
}
|
|
4308
|
+
/** @enumType */
|
|
4309
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4310
|
+
declare enum Namespace {
|
|
4311
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4312
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4313
|
+
WIX = "WIX",
|
|
4314
|
+
/** 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. */
|
|
4315
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
4316
|
+
/** 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. */
|
|
4317
|
+
ALBUMS = "ALBUMS",
|
|
4318
|
+
/** 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. */
|
|
4319
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4320
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4321
|
+
HOTELS = "HOTELS",
|
|
4322
|
+
/** 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. */
|
|
4323
|
+
CLUBS = "CLUBS",
|
|
4324
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4325
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4326
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4327
|
+
DEV_SITE = "DEV_SITE",
|
|
4328
|
+
/** 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. */
|
|
4329
|
+
LOGOS = "LOGOS",
|
|
4330
|
+
/** 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. */
|
|
4331
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4332
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4333
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4334
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4335
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4336
|
+
/**
|
|
4337
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
4338
|
+
*
|
|
4339
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4340
|
+
*/
|
|
4341
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
4342
|
+
/**
|
|
4343
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
4344
|
+
* Will be accessible from Site List and will not have a website app.
|
|
4345
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4346
|
+
*/
|
|
4347
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
4348
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4349
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4350
|
+
/** It is to be used in the Business First efforts. */
|
|
4351
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4352
|
+
/** Bookings business flow with no site. */
|
|
4353
|
+
ANYWHERE = "ANYWHERE",
|
|
4354
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
4355
|
+
HEADLESS = "HEADLESS",
|
|
4356
|
+
/**
|
|
4357
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
4358
|
+
* The site will be used for account level CSM feature for enterprise
|
|
4359
|
+
*/
|
|
4360
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
4361
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4362
|
+
RISE = "RISE",
|
|
4363
|
+
/**
|
|
4364
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
4365
|
+
* There's a blank site behind the scene but it's blank).
|
|
4366
|
+
* The Mobile company will be the owner of this namespace.
|
|
4367
|
+
*/
|
|
4368
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
4369
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4370
|
+
NOWNIA = "NOWNIA",
|
|
4371
|
+
/**
|
|
4372
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
4373
|
+
* The Partners company owns this namespace.
|
|
4374
|
+
*/
|
|
4375
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
4376
|
+
/** Codux Headless Sites */
|
|
4377
|
+
CODUX = "CODUX",
|
|
4378
|
+
/** Bobb - AI Design Creator. */
|
|
4379
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4380
|
+
/**
|
|
4381
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
4382
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
4383
|
+
*/
|
|
4384
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
4385
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4386
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4387
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4388
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4389
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4390
|
+
MIMIR = "MIMIR",
|
|
4391
|
+
/** Wix Twins platform. */
|
|
4392
|
+
TWINS = "TWINS",
|
|
4393
|
+
/** Wix Nano. */
|
|
4394
|
+
NANO = "NANO",
|
|
4395
|
+
/** Base44 headless sites. */
|
|
4396
|
+
BASE44 = "BASE44",
|
|
4397
|
+
/** Wix Channels Sites */
|
|
4398
|
+
CHANNELS = "CHANNELS",
|
|
4399
|
+
/** Nautilus platform. */
|
|
4400
|
+
NAUTILUS = "NAUTILUS"
|
|
4317
4401
|
}
|
|
4318
|
-
|
|
4319
|
-
|
|
4320
|
-
|
|
4402
|
+
/** @enumType */
|
|
4403
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS';
|
|
4404
|
+
/** Site transferred to another user. */
|
|
4405
|
+
interface SiteTransferred {
|
|
4321
4406
|
/**
|
|
4322
|
-
*
|
|
4323
|
-
* @
|
|
4407
|
+
* A previous owner id (user that transfers meta site).
|
|
4408
|
+
* @format GUID
|
|
4324
4409
|
*/
|
|
4325
|
-
|
|
4410
|
+
oldOwnerId?: string;
|
|
4411
|
+
/**
|
|
4412
|
+
* A new owner id (user that accepts meta site).
|
|
4413
|
+
* @format GUID
|
|
4414
|
+
*/
|
|
4415
|
+
newOwnerId?: string;
|
|
4326
4416
|
}
|
|
4327
|
-
|
|
4328
|
-
|
|
4329
|
-
|
|
4330
|
-
|
|
4417
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
4418
|
+
interface SiteDeleted {
|
|
4419
|
+
/** A deletion context. */
|
|
4420
|
+
deleteContext?: DeleteContext;
|
|
4421
|
+
}
|
|
4422
|
+
interface DeleteContext {
|
|
4423
|
+
/** When the meta site was deleted. */
|
|
4424
|
+
dateDeleted?: Date | null;
|
|
4425
|
+
/** A status. */
|
|
4426
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
4427
|
+
/**
|
|
4428
|
+
* A reason (flow).
|
|
4429
|
+
* @maxLength 255
|
|
4430
|
+
*/
|
|
4431
|
+
deleteOrigin?: string;
|
|
4432
|
+
/**
|
|
4433
|
+
* A service that deleted it.
|
|
4434
|
+
* @maxLength 255
|
|
4435
|
+
*/
|
|
4436
|
+
initiatorId?: string | null;
|
|
4437
|
+
}
|
|
4438
|
+
declare enum DeleteStatus {
|
|
4439
|
+
UNKNOWN = "UNKNOWN",
|
|
4440
|
+
TRASH = "TRASH",
|
|
4441
|
+
DELETED = "DELETED",
|
|
4442
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
4443
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
4331
4444
|
}
|
|
4332
4445
|
/** @enumType */
|
|
4333
|
-
type
|
|
4334
|
-
|
|
4446
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
4447
|
+
/** Restoration of the meta site. */
|
|
4448
|
+
interface SiteUndeleted {
|
|
4449
|
+
}
|
|
4450
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
4451
|
+
interface SitePublished {
|
|
4452
|
+
}
|
|
4453
|
+
interface SiteUnpublished {
|
|
4335
4454
|
/**
|
|
4336
|
-
*
|
|
4455
|
+
* A list of URLs previously associated with the meta site.
|
|
4456
|
+
* @maxLength 4000
|
|
4457
|
+
* @maxSize 10000
|
|
4458
|
+
*/
|
|
4459
|
+
urls?: string[];
|
|
4460
|
+
}
|
|
4461
|
+
interface SiteMarkedAsTemplate {
|
|
4462
|
+
}
|
|
4463
|
+
interface SiteMarkedAsWixSite {
|
|
4464
|
+
}
|
|
4465
|
+
/**
|
|
4466
|
+
* Represents a service provisioned a site.
|
|
4467
|
+
*
|
|
4468
|
+
* Note on `origin_instance_id`:
|
|
4469
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
4470
|
+
* This is because of the following scenario:
|
|
4471
|
+
*
|
|
4472
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
4473
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
4474
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
4475
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
4476
|
+
* your site remains consistent with what you initially received and does not include any
|
|
4477
|
+
* changes made to the original template afterward.
|
|
4478
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
4479
|
+
*/
|
|
4480
|
+
interface ServiceProvisioned {
|
|
4481
|
+
/**
|
|
4482
|
+
* Either UUID or EmbeddedServiceType.
|
|
4483
|
+
* @maxLength 36
|
|
4484
|
+
*/
|
|
4485
|
+
appDefId?: string;
|
|
4486
|
+
/**
|
|
4487
|
+
* Not only UUID. Something here could be something weird.
|
|
4488
|
+
* @maxLength 36
|
|
4489
|
+
*/
|
|
4490
|
+
instanceId?: string;
|
|
4491
|
+
/**
|
|
4492
|
+
* An instance id from which this instance is originated.
|
|
4493
|
+
* @maxLength 36
|
|
4494
|
+
*/
|
|
4495
|
+
originInstanceId?: string;
|
|
4496
|
+
/**
|
|
4497
|
+
* A version.
|
|
4498
|
+
* @maxLength 500
|
|
4499
|
+
*/
|
|
4500
|
+
version?: string | null;
|
|
4501
|
+
/**
|
|
4502
|
+
* The origin meta site id
|
|
4337
4503
|
* @format GUID
|
|
4338
4504
|
*/
|
|
4339
|
-
|
|
4505
|
+
originMetaSiteId?: string | null;
|
|
4506
|
+
}
|
|
4507
|
+
interface ServiceRemoved {
|
|
4340
4508
|
/**
|
|
4341
|
-
*
|
|
4342
|
-
* @
|
|
4343
|
-
* @max 100000
|
|
4509
|
+
* Either UUID or EmbeddedServiceType.
|
|
4510
|
+
* @maxLength 36
|
|
4344
4511
|
*/
|
|
4345
|
-
|
|
4512
|
+
appDefId?: string;
|
|
4513
|
+
/**
|
|
4514
|
+
* Not only UUID. Something here could be something weird.
|
|
4515
|
+
* @maxLength 36
|
|
4516
|
+
*/
|
|
4517
|
+
instanceId?: string;
|
|
4518
|
+
/**
|
|
4519
|
+
* A version.
|
|
4520
|
+
* @maxLength 500
|
|
4521
|
+
*/
|
|
4522
|
+
version?: string | null;
|
|
4346
4523
|
}
|
|
4347
|
-
|
|
4348
|
-
|
|
4349
|
-
|
|
4350
|
-
|
|
4351
|
-
|
|
4352
|
-
|
|
4353
|
-
|
|
4524
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
4525
|
+
interface SiteRenamed {
|
|
4526
|
+
/**
|
|
4527
|
+
* A new meta site name (URL slug).
|
|
4528
|
+
* @maxLength 20
|
|
4529
|
+
*/
|
|
4530
|
+
newSiteName?: string;
|
|
4531
|
+
/**
|
|
4532
|
+
* A previous meta site name (URL slug).
|
|
4533
|
+
* @maxLength 255
|
|
4534
|
+
*/
|
|
4535
|
+
oldSiteName?: string;
|
|
4536
|
+
}
|
|
4537
|
+
/**
|
|
4538
|
+
* Hard deletion of the meta site.
|
|
4539
|
+
*
|
|
4540
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
4541
|
+
*/
|
|
4542
|
+
interface SiteHardDeleted {
|
|
4543
|
+
/** A deletion context. */
|
|
4544
|
+
deleteContext?: DeleteContext;
|
|
4545
|
+
}
|
|
4546
|
+
interface NamespaceChanged {
|
|
4547
|
+
/** A previous namespace. */
|
|
4548
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
4549
|
+
/** A new namespace. */
|
|
4550
|
+
newNamespace?: NamespaceWithLiterals;
|
|
4551
|
+
}
|
|
4552
|
+
/** Assigned Studio editor */
|
|
4553
|
+
interface StudioAssigned {
|
|
4554
|
+
}
|
|
4555
|
+
/** Unassigned Studio editor */
|
|
4556
|
+
interface StudioUnassigned {
|
|
4557
|
+
}
|
|
4558
|
+
/**
|
|
4559
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4560
|
+
*
|
|
4561
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4562
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4563
|
+
*
|
|
4564
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4565
|
+
*/
|
|
4566
|
+
interface SiteUrlChanged {
|
|
4567
|
+
}
|
|
4568
|
+
/**
|
|
4569
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4570
|
+
* Consumed by other teams to remove relevant data.
|
|
4571
|
+
*/
|
|
4572
|
+
interface SitePurgedExternally {
|
|
4573
|
+
/**
|
|
4574
|
+
* @maxLength 2048
|
|
4575
|
+
* @maxSize 100
|
|
4576
|
+
* @deprecated
|
|
4577
|
+
* @targetRemovalDate 2025-04-15
|
|
4578
|
+
*/
|
|
4579
|
+
appDefId?: string[];
|
|
4580
|
+
}
|
|
4581
|
+
/** Assigned Odeditor */
|
|
4582
|
+
interface OdeditorAssigned {
|
|
4583
|
+
}
|
|
4584
|
+
/** Unassigned Odeditor */
|
|
4585
|
+
interface OdeditorUnassigned {
|
|
4586
|
+
}
|
|
4587
|
+
/** Assigned Picasso editor */
|
|
4588
|
+
interface PicassoAssigned {
|
|
4589
|
+
}
|
|
4590
|
+
/** Unassigned Picasso */
|
|
4591
|
+
interface PicassoUnassigned {
|
|
4592
|
+
}
|
|
4593
|
+
/** Assigned Wixel */
|
|
4594
|
+
interface WixelAssigned {
|
|
4595
|
+
}
|
|
4596
|
+
/** Unassigned Wixel */
|
|
4597
|
+
interface WixelUnassigned {
|
|
4598
|
+
}
|
|
4599
|
+
/** Assigned StudioTwo */
|
|
4600
|
+
interface StudioTwoAssigned {
|
|
4601
|
+
}
|
|
4602
|
+
/** Unassigned StudioTwo */
|
|
4603
|
+
interface StudioTwoUnassigned {
|
|
4604
|
+
}
|
|
4605
|
+
/** Media from user domain is enabled. */
|
|
4606
|
+
interface UserDomainMediaEnabled {
|
|
4607
|
+
}
|
|
4608
|
+
/** Media from user domain is disabled. */
|
|
4609
|
+
interface UserDomainMediaDisabled {
|
|
4610
|
+
}
|
|
4611
|
+
/** Assigned Editorless */
|
|
4612
|
+
interface EditorlessAssigned {
|
|
4613
|
+
}
|
|
4614
|
+
/** Unassigned Editorless */
|
|
4615
|
+
interface EditorlessUnassigned {
|
|
4616
|
+
}
|
|
4617
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
4618
|
+
}
|
|
4619
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
4620
|
+
hasCustomConfigurations?: boolean;
|
|
4621
|
+
}
|
|
4622
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
4623
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
4624
|
+
sendCustomEmailConfigs?: boolean;
|
|
4625
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
4626
|
+
origin?: OriginWithLiterals;
|
|
4354
4627
|
}
|
|
4355
|
-
|
|
4356
|
-
|
|
4357
|
-
|
|
4358
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
4359
|
-
*/
|
|
4360
|
-
interface OrderTransactions {
|
|
4361
|
-
/**
|
|
4362
|
-
* Order ID.
|
|
4363
|
-
* @format GUID
|
|
4364
|
-
*/
|
|
4365
|
-
orderId?: string;
|
|
4366
|
-
/**
|
|
4367
|
-
* Record of payments made to the merchant.
|
|
4368
|
-
* @maxSize 100
|
|
4369
|
-
*/
|
|
4370
|
-
payments?: Payment[];
|
|
4371
|
-
/**
|
|
4372
|
-
* Record of refunds made to the buyer.
|
|
4373
|
-
* @maxSize 300
|
|
4374
|
-
*/
|
|
4375
|
-
refunds?: Refund[];
|
|
4628
|
+
declare enum Origin {
|
|
4629
|
+
OPT_IN = "OPT_IN",
|
|
4630
|
+
MIGRATION = "MIGRATION"
|
|
4376
4631
|
}
|
|
4377
|
-
|
|
4378
|
-
|
|
4379
|
-
|
|
4380
|
-
|
|
4381
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4382
|
-
/**
|
|
4383
|
-
* Payment ID.
|
|
4384
|
-
* @format GUID
|
|
4385
|
-
* @readonly
|
|
4386
|
-
*/
|
|
4387
|
-
id?: string | null;
|
|
4388
|
-
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
4389
|
-
createdDate?: Date | null;
|
|
4390
|
-
/**
|
|
4391
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
4392
|
-
* @readonly
|
|
4393
|
-
*/
|
|
4394
|
-
updatedDate?: Date | null;
|
|
4395
|
-
/** Payment amount. */
|
|
4396
|
-
amount?: Price;
|
|
4397
|
-
/**
|
|
4398
|
-
* Whether refunds for this payment are disabled.
|
|
4399
|
-
* + `true`: This payment is not refundable.
|
|
4400
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
4401
|
-
*/
|
|
4402
|
-
refundDisabled?: boolean;
|
|
4632
|
+
/** @enumType */
|
|
4633
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
4634
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
4635
|
+
success?: boolean;
|
|
4403
4636
|
}
|
|
4404
|
-
|
|
4405
|
-
interface PaymentPaymentDetailsOneOf {
|
|
4406
|
-
/** Regular payment details. */
|
|
4407
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
4408
|
-
/** Gift card payment details. */
|
|
4409
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4637
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
4410
4638
|
}
|
|
4411
|
-
|
|
4412
|
-
|
|
4639
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
4640
|
+
inPopulation?: boolean;
|
|
4413
4641
|
}
|
|
4414
|
-
interface
|
|
4415
|
-
/** Credit card details. */
|
|
4416
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4642
|
+
interface PreparePaymentCollectionRequest {
|
|
4417
4643
|
/**
|
|
4418
|
-
*
|
|
4644
|
+
* Ecom order ID.
|
|
4645
|
+
* @minLength 1
|
|
4419
4646
|
* @maxLength 100
|
|
4420
4647
|
*/
|
|
4421
|
-
|
|
4648
|
+
ecomOrderId: string;
|
|
4649
|
+
/** Amount to collect */
|
|
4650
|
+
amount: Price;
|
|
4422
4651
|
/**
|
|
4423
|
-
*
|
|
4424
|
-
*
|
|
4425
|
-
*
|
|
4652
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4653
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
4654
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4426
4655
|
*/
|
|
4427
|
-
|
|
4656
|
+
paymentGatewayOrderId?: string | null;
|
|
4428
4657
|
/**
|
|
4429
|
-
*
|
|
4430
|
-
*
|
|
4431
|
-
*
|
|
4432
|
-
*
|
|
4433
|
-
* @
|
|
4434
|
-
* @
|
|
4435
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4436
|
-
* Non-exhaustive list of supported values:
|
|
4437
|
-
* + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
|
|
4438
|
-
* @replacedBy payment_method_name
|
|
4439
|
-
* @targetRemovalDate 2026-07-01
|
|
4658
|
+
* Whether to delay capture of the payment.
|
|
4659
|
+
* Default: false
|
|
4660
|
+
* @deprecated Whether to delay capture of the payment.
|
|
4661
|
+
* Default: false
|
|
4662
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4663
|
+
* @targetRemovalDate 2024-09-30
|
|
4440
4664
|
*/
|
|
4441
|
-
|
|
4665
|
+
delayedCapture?: boolean;
|
|
4666
|
+
/** Delayed capture payment settings */
|
|
4667
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4668
|
+
}
|
|
4669
|
+
interface RedirectUrls {
|
|
4442
4670
|
/**
|
|
4443
|
-
*
|
|
4444
|
-
* @
|
|
4671
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4672
|
+
* @format WEB_URL
|
|
4445
4673
|
*/
|
|
4446
|
-
|
|
4447
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
4448
|
-
offlinePayment?: boolean;
|
|
4449
|
-
/** Payment status. */
|
|
4450
|
-
status?: TransactionStatusWithLiterals;
|
|
4674
|
+
successUrl?: string | null;
|
|
4451
4675
|
/**
|
|
4452
|
-
*
|
|
4453
|
-
* @
|
|
4676
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4677
|
+
* @format WEB_URL
|
|
4454
4678
|
*/
|
|
4455
|
-
|
|
4456
|
-
/** Authorization details. */
|
|
4457
|
-
authorizationDetails?: AuthorizationDetails;
|
|
4679
|
+
cancelUrl?: string | null;
|
|
4458
4680
|
/**
|
|
4459
|
-
*
|
|
4460
|
-
* @
|
|
4681
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4682
|
+
* @format WEB_URL
|
|
4461
4683
|
*/
|
|
4462
|
-
|
|
4463
|
-
/** Platform fee amount associated with this payment. */
|
|
4464
|
-
platformFee?: Price;
|
|
4684
|
+
errorUrl?: string | null;
|
|
4465
4685
|
/**
|
|
4466
|
-
*
|
|
4467
|
-
*
|
|
4468
|
-
* + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
|
|
4686
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4687
|
+
* @format WEB_URL
|
|
4469
4688
|
*/
|
|
4470
|
-
|
|
4689
|
+
pendingUrl?: string | null;
|
|
4471
4690
|
}
|
|
4472
|
-
|
|
4473
|
-
|
|
4474
|
-
|
|
4475
|
-
|
|
4691
|
+
interface DelayedCaptureSettings {
|
|
4692
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4693
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
4694
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4695
|
+
delayDuration?: Duration;
|
|
4476
4696
|
}
|
|
4477
|
-
declare enum
|
|
4478
|
-
|
|
4479
|
-
|
|
4480
|
-
|
|
4481
|
-
|
|
4482
|
-
CANCELED = "CANCELED",
|
|
4483
|
-
DECLINED = "DECLINED",
|
|
4484
|
-
REFUNDED = "REFUNDED",
|
|
4485
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4486
|
-
AUTHORIZED = "AUTHORIZED",
|
|
4487
|
-
VOIDED = "VOIDED"
|
|
4697
|
+
declare enum ScheduledAction {
|
|
4698
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
4699
|
+
VOID = "VOID",
|
|
4700
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
4701
|
+
CAPTURE = "CAPTURE"
|
|
4488
4702
|
}
|
|
4489
4703
|
/** @enumType */
|
|
4490
|
-
type
|
|
4491
|
-
interface
|
|
4492
|
-
/**
|
|
4493
|
-
* The last 4 digits of the card number.
|
|
4494
|
-
* @maxLength 4
|
|
4495
|
-
*/
|
|
4496
|
-
lastFourDigits?: string | null;
|
|
4497
|
-
/**
|
|
4498
|
-
* Card issuer's brand.
|
|
4499
|
-
* @maxLength 100
|
|
4500
|
-
*/
|
|
4501
|
-
brand?: string | null;
|
|
4502
|
-
}
|
|
4503
|
-
interface AuthorizationDetails {
|
|
4504
|
-
/**
|
|
4505
|
-
* Whether the authorized payment is of a delayed capture.
|
|
4506
|
-
* @readonly
|
|
4507
|
-
*/
|
|
4508
|
-
delayedCapture?: boolean;
|
|
4509
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4510
|
-
authorizedDate?: Date | null;
|
|
4511
|
-
/**
|
|
4512
|
-
* List of captures associated with payment
|
|
4513
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
4514
|
-
* @maxSize 1
|
|
4515
|
-
*/
|
|
4516
|
-
captures?: AuthorizationCapture[];
|
|
4517
|
-
/** Void associated with payment */
|
|
4518
|
-
void?: AuthorizationVoid;
|
|
4519
|
-
/** Scheduled action for this transaction */
|
|
4520
|
-
scheduledAction?: V1ScheduledAction;
|
|
4521
|
-
}
|
|
4522
|
-
interface AuthorizationCapture {
|
|
4523
|
-
/**
|
|
4524
|
-
* Capture ID.
|
|
4525
|
-
* @format GUID
|
|
4526
|
-
* @readonly
|
|
4527
|
-
*/
|
|
4528
|
-
id?: string | null;
|
|
4529
|
-
/** Status of this capture action */
|
|
4530
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
4704
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4705
|
+
interface Duration {
|
|
4531
4706
|
/**
|
|
4532
|
-
* Amount of
|
|
4533
|
-
* @
|
|
4707
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4708
|
+
* @min 1
|
|
4534
4709
|
*/
|
|
4535
|
-
|
|
4536
|
-
/**
|
|
4537
|
-
|
|
4538
|
-
/** In case of status is FAILED may contain failure details */
|
|
4539
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4540
|
-
}
|
|
4541
|
-
declare enum AuthorizationCaptureStatus {
|
|
4542
|
-
/** Capture operation still in progress. */
|
|
4543
|
-
PENDING = "PENDING",
|
|
4544
|
-
/** Capture operation succeeded. */
|
|
4545
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4546
|
-
/** Capture operation failed. */
|
|
4547
|
-
FAILED = "FAILED"
|
|
4548
|
-
}
|
|
4549
|
-
/** @enumType */
|
|
4550
|
-
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4551
|
-
interface AuthorizationActionFailureDetails {
|
|
4552
|
-
/** @maxLength 100 */
|
|
4553
|
-
failureCode?: string;
|
|
4554
|
-
}
|
|
4555
|
-
interface AuthorizationVoid {
|
|
4556
|
-
/** Status of this void action */
|
|
4557
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
4558
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4559
|
-
voidedDate?: Date | null;
|
|
4560
|
-
/** In case of status is FAILED may contain failure details */
|
|
4561
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4562
|
-
/** Reason of void action */
|
|
4563
|
-
reason?: ReasonWithLiterals;
|
|
4710
|
+
count?: number;
|
|
4711
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4712
|
+
unit?: DurationUnitWithLiterals;
|
|
4564
4713
|
}
|
|
4565
|
-
declare enum
|
|
4566
|
-
|
|
4567
|
-
|
|
4568
|
-
|
|
4569
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4570
|
-
/** Void operation failed. */
|
|
4571
|
-
FAILED = "FAILED"
|
|
4714
|
+
declare enum DurationUnit {
|
|
4715
|
+
MINUTES = "MINUTES",
|
|
4716
|
+
HOURS = "HOURS",
|
|
4717
|
+
DAYS = "DAYS"
|
|
4572
4718
|
}
|
|
4573
4719
|
/** @enumType */
|
|
4574
|
-
type
|
|
4575
|
-
|
|
4576
|
-
|
|
4577
|
-
|
|
4578
|
-
MANUAL = "MANUAL",
|
|
4579
|
-
/** Authorization passed execution date. */
|
|
4580
|
-
SCHEDULED = "SCHEDULED"
|
|
4720
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4721
|
+
interface PreparePaymentCollectionResponse {
|
|
4722
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4723
|
+
paymentGatewayOrderId?: string;
|
|
4581
4724
|
}
|
|
4582
|
-
|
|
4583
|
-
|
|
4584
|
-
|
|
4585
|
-
|
|
4586
|
-
|
|
4587
|
-
|
|
4588
|
-
|
|
4725
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4726
|
+
/**
|
|
4727
|
+
* Ecom order ID.
|
|
4728
|
+
* @minLength 1
|
|
4729
|
+
* @maxLength 100
|
|
4730
|
+
*/
|
|
4731
|
+
ecomOrderId: string;
|
|
4589
4732
|
}
|
|
4590
|
-
|
|
4591
|
-
|
|
4592
|
-
|
|
4733
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4734
|
+
/** Payment collectability status */
|
|
4735
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4736
|
+
/** Collectable order amount */
|
|
4737
|
+
amount?: Price;
|
|
4738
|
+
}
|
|
4739
|
+
declare enum PaymentCollectabilityStatus {
|
|
4740
|
+
UNKNOWN = "UNKNOWN",
|
|
4741
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4742
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4743
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4744
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4745
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4746
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4747
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4748
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4749
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4750
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4751
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
4593
4752
|
}
|
|
4594
4753
|
/** @enumType */
|
|
4595
|
-
type
|
|
4596
|
-
interface
|
|
4754
|
+
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED';
|
|
4755
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4597
4756
|
/**
|
|
4598
|
-
*
|
|
4599
|
-
* @
|
|
4600
|
-
* @
|
|
4601
|
-
* @immutable
|
|
4757
|
+
* Order ID.
|
|
4758
|
+
* @minLength 1
|
|
4759
|
+
* @maxLength 100
|
|
4602
4760
|
*/
|
|
4603
|
-
|
|
4761
|
+
orderId: string;
|
|
4762
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4763
|
+
amount: Price;
|
|
4764
|
+
}
|
|
4765
|
+
/**
|
|
4766
|
+
* User-defined payment method name.
|
|
4767
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4768
|
+
*/
|
|
4769
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4770
|
+
/** Predefined payment method. */
|
|
4771
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4604
4772
|
/**
|
|
4605
|
-
*
|
|
4606
|
-
*
|
|
4607
|
-
*
|
|
4773
|
+
* Custom payment method name provided by user.
|
|
4774
|
+
*
|
|
4775
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4776
|
+
* @minLength 1
|
|
4777
|
+
* @maxLength 100
|
|
4608
4778
|
*/
|
|
4609
|
-
|
|
4779
|
+
custom?: string | null;
|
|
4780
|
+
}
|
|
4781
|
+
/** @oneof */
|
|
4782
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4783
|
+
/** Predefined payment method. */
|
|
4784
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4610
4785
|
/**
|
|
4611
|
-
*
|
|
4612
|
-
*
|
|
4786
|
+
* Custom payment method name provided by user.
|
|
4787
|
+
*
|
|
4788
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4789
|
+
* @minLength 1
|
|
4790
|
+
* @maxLength 100
|
|
4613
4791
|
*/
|
|
4614
|
-
|
|
4792
|
+
custom?: string | null;
|
|
4793
|
+
}
|
|
4794
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
4795
|
+
declare enum PredefinedPaymentMethod {
|
|
4796
|
+
/** Cash payment. */
|
|
4797
|
+
CASH = "CASH",
|
|
4798
|
+
/** Bank transfer. */
|
|
4799
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4800
|
+
/** Payment by check. */
|
|
4801
|
+
CHECK = "CHECK"
|
|
4802
|
+
}
|
|
4803
|
+
/** @enumType */
|
|
4804
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4805
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4806
|
+
}
|
|
4807
|
+
interface MarkOrderAsPaidRequest {
|
|
4615
4808
|
/**
|
|
4616
|
-
*
|
|
4617
|
-
* @
|
|
4618
|
-
* @
|
|
4809
|
+
* Ecom order ID.
|
|
4810
|
+
* @minLength 1
|
|
4811
|
+
* @maxLength 100
|
|
4619
4812
|
*/
|
|
4620
|
-
|
|
4813
|
+
ecomOrderId: string;
|
|
4814
|
+
}
|
|
4815
|
+
interface MarkOrderAsPaidResponse {
|
|
4816
|
+
/** Updated order. */
|
|
4817
|
+
order?: Order;
|
|
4818
|
+
}
|
|
4819
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4621
4820
|
/**
|
|
4622
|
-
*
|
|
4623
|
-
* @
|
|
4821
|
+
* IDs of orders to mark as paid.
|
|
4822
|
+
* @minSize 1
|
|
4823
|
+
* @maxSize 100
|
|
4824
|
+
* @minLength 1
|
|
4825
|
+
* @maxLength 100
|
|
4624
4826
|
*/
|
|
4625
|
-
|
|
4827
|
+
ecomOrderIds: string[];
|
|
4828
|
+
}
|
|
4829
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4626
4830
|
/**
|
|
4627
|
-
*
|
|
4628
|
-
*
|
|
4629
|
-
* Default: `"APPROVED"`.
|
|
4831
|
+
* Items updated by the bulk action.
|
|
4832
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4630
4833
|
*/
|
|
4631
|
-
|
|
4834
|
+
results?: BulkOrderResult[];
|
|
4835
|
+
/** Bulk action metadata. */
|
|
4836
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4837
|
+
}
|
|
4838
|
+
interface BulkOrderResult {
|
|
4839
|
+
/** Item metadata. */
|
|
4840
|
+
itemMetadata?: ItemMetadata;
|
|
4632
4841
|
/**
|
|
4633
|
-
*
|
|
4634
|
-
*
|
|
4635
|
-
*
|
|
4636
|
-
* @immutable
|
|
4842
|
+
* Updated order.
|
|
4843
|
+
*
|
|
4844
|
+
* Returned when `returnFullEntity = true`.
|
|
4637
4845
|
*/
|
|
4638
|
-
|
|
4846
|
+
item?: Order;
|
|
4639
4847
|
}
|
|
4640
|
-
|
|
4641
|
-
/**
|
|
4642
|
-
|
|
4643
|
-
/**
|
|
4644
|
-
|
|
4848
|
+
interface ItemMetadata {
|
|
4849
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4850
|
+
id?: string | null;
|
|
4851
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4852
|
+
originalIndex?: number;
|
|
4853
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4854
|
+
success?: boolean;
|
|
4855
|
+
/** Details about the error in case of failure. */
|
|
4856
|
+
error?: ApplicationError;
|
|
4645
4857
|
}
|
|
4646
|
-
|
|
4647
|
-
|
|
4648
|
-
|
|
4858
|
+
interface ApplicationError {
|
|
4859
|
+
/** Error code. */
|
|
4860
|
+
code?: string;
|
|
4861
|
+
/** Description of the error. */
|
|
4862
|
+
description?: string;
|
|
4863
|
+
/** Data related to the error. */
|
|
4864
|
+
data?: Record<string, any> | null;
|
|
4865
|
+
}
|
|
4866
|
+
interface BulkActionMetadata {
|
|
4867
|
+
/** Number of items that were successfully processed. */
|
|
4868
|
+
totalSuccesses?: number;
|
|
4869
|
+
/** Number of items that couldn't be processed. */
|
|
4870
|
+
totalFailures?: number;
|
|
4871
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4872
|
+
undetailedFailures?: number;
|
|
4873
|
+
}
|
|
4874
|
+
interface GetRefundabilityStatusRequest {
|
|
4649
4875
|
/**
|
|
4650
|
-
*
|
|
4876
|
+
* Order ID.
|
|
4877
|
+
* @minLength 1
|
|
4651
4878
|
* @maxLength 100
|
|
4652
4879
|
*/
|
|
4653
|
-
|
|
4880
|
+
ecomOrderId: string;
|
|
4881
|
+
}
|
|
4882
|
+
interface GetRefundabilityStatusResponse {
|
|
4654
4883
|
/**
|
|
4655
|
-
*
|
|
4656
|
-
* @
|
|
4884
|
+
* Refundability details.
|
|
4885
|
+
* @maxSize 300
|
|
4657
4886
|
*/
|
|
4658
|
-
|
|
4887
|
+
refundabilities?: Refundability[];
|
|
4659
4888
|
/**
|
|
4660
|
-
*
|
|
4661
|
-
*
|
|
4662
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
4889
|
+
* Whether the order supports refunding per item.
|
|
4890
|
+
* @deprecated
|
|
4663
4891
|
*/
|
|
4664
|
-
|
|
4892
|
+
refundablePerItem?: boolean;
|
|
4893
|
+
}
|
|
4894
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4895
|
+
/** Reason why payment is not refundable. */
|
|
4896
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4897
|
+
/** Reason why payment is only refundable manually. */
|
|
4898
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4899
|
+
/** Payment ID. */
|
|
4900
|
+
paymentId?: string;
|
|
4901
|
+
/** Payment refundability status. */
|
|
4902
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4903
|
+
/** Link to payment provider dashboard. */
|
|
4904
|
+
providerLink?: string | null;
|
|
4905
|
+
}
|
|
4906
|
+
/** @oneof */
|
|
4907
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4908
|
+
/** Reason why payment is not refundable. */
|
|
4909
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4910
|
+
/** Reason why payment is only refundable manually. */
|
|
4911
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4912
|
+
}
|
|
4913
|
+
declare enum RefundableStatus {
|
|
4914
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4915
|
+
MANUAL = "MANUAL",
|
|
4916
|
+
REFUNDABLE = "REFUNDABLE"
|
|
4917
|
+
}
|
|
4918
|
+
/** @enumType */
|
|
4919
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4920
|
+
declare enum NonRefundableReason {
|
|
4921
|
+
NONE = "NONE",
|
|
4922
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4923
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4924
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4925
|
+
NOT_PAID = "NOT_PAID",
|
|
4926
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4927
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
4928
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4929
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
4930
|
+
FORBIDDEN = "FORBIDDEN",
|
|
4931
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4932
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4933
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4934
|
+
}
|
|
4935
|
+
/** @enumType */
|
|
4936
|
+
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';
|
|
4937
|
+
declare enum ManuallyRefundableReason {
|
|
4938
|
+
EXPIRED = "EXPIRED",
|
|
4939
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4940
|
+
OFFLINE = "OFFLINE",
|
|
4941
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4665
4942
|
}
|
|
4666
|
-
|
|
4943
|
+
/** @enumType */
|
|
4944
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4945
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
4667
4946
|
/**
|
|
4668
|
-
*
|
|
4947
|
+
* Ecom order ID.
|
|
4948
|
+
* @minLength 1
|
|
4669
4949
|
* @maxLength 100
|
|
4670
4950
|
*/
|
|
4671
|
-
|
|
4672
|
-
/**
|
|
4673
|
-
|
|
4674
|
-
* @format GUID
|
|
4675
|
-
*/
|
|
4676
|
-
appId?: string;
|
|
4677
|
-
/**
|
|
4678
|
-
* Whether the gift card is voided.
|
|
4679
|
-
* @readonly
|
|
4680
|
-
*/
|
|
4681
|
-
voided?: boolean;
|
|
4951
|
+
ecomOrderId: string;
|
|
4952
|
+
/** Information about the user who initiated the payment. */
|
|
4953
|
+
chargedBy?: ChargedBy;
|
|
4682
4954
|
}
|
|
4683
|
-
interface
|
|
4955
|
+
interface ChargedBy {
|
|
4684
4956
|
/**
|
|
4685
|
-
*
|
|
4686
|
-
* @
|
|
4687
|
-
* @maxLength 100
|
|
4957
|
+
* ID - id of the user who initiated the payment
|
|
4958
|
+
* @format GUID
|
|
4688
4959
|
*/
|
|
4689
|
-
|
|
4960
|
+
id?: string;
|
|
4690
4961
|
/**
|
|
4691
|
-
*
|
|
4962
|
+
* Full name - name of the user who initiated the payment
|
|
4692
4963
|
* @minLength 1
|
|
4693
|
-
* @maxLength
|
|
4964
|
+
* @maxLength 200
|
|
4694
4965
|
*/
|
|
4695
|
-
|
|
4696
|
-
|
|
4697
|
-
|
|
4698
|
-
/**
|
|
4699
|
-
|
|
4966
|
+
fullName?: string | null;
|
|
4967
|
+
}
|
|
4968
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4969
|
+
/** ID of the order created in the payment gateway */
|
|
4970
|
+
paymentGatewayOrderId?: string;
|
|
4971
|
+
}
|
|
4972
|
+
interface ChargeMembershipsRequest {
|
|
4700
4973
|
/**
|
|
4701
|
-
*
|
|
4974
|
+
* Order ID.
|
|
4702
4975
|
* @minLength 1
|
|
4703
4976
|
* @maxLength 100
|
|
4704
4977
|
*/
|
|
4705
|
-
|
|
4706
|
-
/**
|
|
4707
|
-
* Whether the membership is voided.
|
|
4708
|
-
* @readonly
|
|
4709
|
-
*/
|
|
4710
|
-
voided?: boolean;
|
|
4711
|
-
/**
|
|
4712
|
-
* ID of the application providing this payment option.
|
|
4713
|
-
* @format GUID
|
|
4714
|
-
*/
|
|
4715
|
-
providerAppId?: string;
|
|
4716
|
-
}
|
|
4717
|
-
declare enum MembershipPaymentStatus {
|
|
4718
|
-
/** Payment was charged. */
|
|
4719
|
-
CHARGED = "CHARGED",
|
|
4720
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
4721
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
4722
|
-
/** Payment is pending. */
|
|
4723
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
4724
|
-
/** Payment was voided. */
|
|
4725
|
-
VOIDED = "VOIDED"
|
|
4726
|
-
}
|
|
4727
|
-
/** @enumType */
|
|
4728
|
-
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
4729
|
-
interface WixReceiptInfo {
|
|
4978
|
+
ecomOrderId: string;
|
|
4730
4979
|
/**
|
|
4731
|
-
*
|
|
4980
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4981
|
+
* but a user which is using the membership on behalf of the a member
|
|
4732
4982
|
* @format GUID
|
|
4733
4983
|
*/
|
|
4734
|
-
|
|
4984
|
+
memberId: string;
|
|
4735
4985
|
/**
|
|
4736
|
-
*
|
|
4737
|
-
* @
|
|
4738
|
-
* @
|
|
4986
|
+
* List of items to be paid by memberships
|
|
4987
|
+
* @minSize 1
|
|
4988
|
+
* @maxSize 300
|
|
4739
4989
|
*/
|
|
4740
|
-
|
|
4990
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4741
4991
|
}
|
|
4742
|
-
interface
|
|
4992
|
+
interface MembershipChargeItem {
|
|
4743
4993
|
/**
|
|
4744
|
-
*
|
|
4994
|
+
* The id of used membership
|
|
4995
|
+
* @minLength 1
|
|
4745
4996
|
* @maxLength 100
|
|
4746
4997
|
*/
|
|
4747
|
-
|
|
4998
|
+
membershipId?: string;
|
|
4748
4999
|
/**
|
|
4749
|
-
* ID of the
|
|
5000
|
+
* ID of the application providing this payment option
|
|
4750
5001
|
* @format GUID
|
|
4751
5002
|
*/
|
|
4752
|
-
appId?: string
|
|
5003
|
+
appId?: string;
|
|
5004
|
+
/** The name of used membership */
|
|
5005
|
+
membershipName?: MembershipName;
|
|
5006
|
+
/** Additional data about this membership */
|
|
5007
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
5008
|
+
/** Catalog and item reference info. */
|
|
5009
|
+
catalogReference?: CatalogReference;
|
|
5010
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5011
|
+
serviceProperties?: ServiceProperties;
|
|
4753
5012
|
/**
|
|
4754
|
-
*
|
|
5013
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
5014
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
5015
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4755
5016
|
* @minLength 1
|
|
4756
|
-
* @maxLength
|
|
4757
|
-
*/
|
|
4758
|
-
displayNumber?: string | null;
|
|
4759
|
-
}
|
|
4760
|
-
interface CashRoundingDetails {
|
|
4761
|
-
}
|
|
4762
|
-
declare enum PaymentStatus {
|
|
4763
|
-
APPROVED = "APPROVED",
|
|
4764
|
-
PENDING = "PENDING",
|
|
4765
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4766
|
-
CANCELED = "CANCELED",
|
|
4767
|
-
DECLINED = "DECLINED",
|
|
4768
|
-
REFUNDED = "REFUNDED",
|
|
4769
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4770
|
-
AUTHORIZED = "AUTHORIZED",
|
|
4771
|
-
VOIDED = "VOIDED"
|
|
4772
|
-
}
|
|
4773
|
-
/** @enumType */
|
|
4774
|
-
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4775
|
-
interface Refund {
|
|
4776
|
-
/**
|
|
4777
|
-
* Refund ID.
|
|
4778
|
-
* @format GUID
|
|
4779
|
-
* @readonly
|
|
4780
|
-
*/
|
|
4781
|
-
id?: string;
|
|
4782
|
-
/**
|
|
4783
|
-
* List of transactions.
|
|
4784
|
-
* @maxSize 50
|
|
4785
|
-
*/
|
|
4786
|
-
transactions?: RefundTransaction[];
|
|
4787
|
-
/** Refund business details. */
|
|
4788
|
-
details?: RefundDetails;
|
|
4789
|
-
/**
|
|
4790
|
-
* Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
|
|
4791
|
-
* @readonly
|
|
4792
|
-
* @immutable
|
|
4793
|
-
*/
|
|
4794
|
-
createdDate?: Date | null;
|
|
4795
|
-
/**
|
|
4796
|
-
* Aggregated refund summary.
|
|
4797
|
-
* @readonly
|
|
5017
|
+
* @maxLength 36
|
|
4798
5018
|
*/
|
|
4799
|
-
|
|
5019
|
+
rootCatalogItemId?: string | null;
|
|
4800
5020
|
/**
|
|
4801
|
-
*
|
|
4802
|
-
* @
|
|
4803
|
-
* @
|
|
4804
|
-
* @immutable
|
|
5021
|
+
* line item id of Checkout/Order line item
|
|
5022
|
+
* @minLength 1
|
|
5023
|
+
* @maxLength 100
|
|
4805
5024
|
*/
|
|
4806
|
-
|
|
5025
|
+
lineItemId?: string;
|
|
4807
5026
|
}
|
|
4808
|
-
interface
|
|
5027
|
+
interface MembershipName {
|
|
4809
5028
|
/**
|
|
4810
|
-
*
|
|
4811
|
-
* @
|
|
4812
|
-
* @immutable
|
|
5029
|
+
* Membership name.
|
|
5030
|
+
* @maxLength 100
|
|
4813
5031
|
*/
|
|
4814
|
-
|
|
5032
|
+
original?: string;
|
|
4815
5033
|
/**
|
|
4816
|
-
*
|
|
4817
|
-
* @
|
|
5034
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
5035
|
+
* @maxLength 100
|
|
4818
5036
|
*/
|
|
4819
|
-
|
|
4820
|
-
|
|
4821
|
-
|
|
4822
|
-
/** Optional details of current refund status. */
|
|
4823
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
5037
|
+
translated?: string | null;
|
|
5038
|
+
}
|
|
5039
|
+
interface ServiceProperties {
|
|
4824
5040
|
/**
|
|
4825
|
-
*
|
|
4826
|
-
*
|
|
4827
|
-
* @format GUID
|
|
5041
|
+
* 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.
|
|
5042
|
+
* For example, the start time of a class.
|
|
4828
5043
|
*/
|
|
4829
|
-
|
|
4830
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
4831
|
-
providerRefundId?: string | null;
|
|
5044
|
+
scheduledDate?: Date | null;
|
|
4832
5045
|
/**
|
|
4833
|
-
*
|
|
4834
|
-
* @
|
|
5046
|
+
* 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.
|
|
5047
|
+
* @min 1
|
|
5048
|
+
* @max 10000
|
|
4835
5049
|
*/
|
|
4836
|
-
|
|
5050
|
+
numberOfParticipants?: number | null;
|
|
4837
5051
|
}
|
|
4838
|
-
|
|
4839
|
-
declare enum RefundStatus {
|
|
4840
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
4841
|
-
PENDING = "PENDING",
|
|
4842
|
-
/** Refund transaction succeeded. */
|
|
4843
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4844
|
-
/** Refund transaction failed. */
|
|
4845
|
-
FAILED = "FAILED",
|
|
4846
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
4847
|
-
SCHEDULED = "SCHEDULED",
|
|
4848
|
-
/** Refund was initiated on payment provider side. */
|
|
4849
|
-
STARTED = "STARTED"
|
|
5052
|
+
interface ChargeMembershipsResponse {
|
|
4850
5053
|
}
|
|
4851
|
-
|
|
4852
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
4853
|
-
interface RefundStatusInfo {
|
|
4854
|
-
/**
|
|
4855
|
-
* Reason code for the refund's current status.
|
|
4856
|
-
*
|
|
4857
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
4858
|
-
* @minLength 1
|
|
4859
|
-
* @maxLength 10
|
|
4860
|
-
*/
|
|
4861
|
-
paymentGatewayReasonCode?: string | null;
|
|
5054
|
+
interface TriggerRefundRequest {
|
|
4862
5055
|
/**
|
|
4863
|
-
*
|
|
5056
|
+
* The order this refund related to
|
|
4864
5057
|
* @minLength 1
|
|
4865
|
-
* @maxLength
|
|
5058
|
+
* @maxLength 100
|
|
4866
5059
|
*/
|
|
4867
|
-
|
|
4868
|
-
|
|
4869
|
-
|
|
4870
|
-
|
|
4871
|
-
|
|
4872
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
4873
|
-
pendingRefund?: Price;
|
|
4874
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
4875
|
-
refunded?: Price;
|
|
4876
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
4877
|
-
failedRefundAmount?: Price;
|
|
4878
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
4879
|
-
pending?: boolean;
|
|
4880
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
4881
|
-
breakdown?: RefundItemsBreakdown;
|
|
4882
|
-
}
|
|
4883
|
-
interface RefundItemsBreakdown {
|
|
4884
|
-
/**
|
|
4885
|
-
* Refunded line items and the amount refunded for each.
|
|
4886
|
-
* @maxSize 300
|
|
5060
|
+
ecomOrderId: string;
|
|
5061
|
+
/**
|
|
5062
|
+
* Refund operations information
|
|
5063
|
+
* @minSize 1
|
|
5064
|
+
* @maxSize 1
|
|
4887
5065
|
*/
|
|
4888
|
-
|
|
5066
|
+
payments: PaymentRefund[];
|
|
5067
|
+
/** Business model of a refund */
|
|
5068
|
+
details?: RefundDetails;
|
|
5069
|
+
/** Side effect details related to refund */
|
|
5070
|
+
sideEffects?: RefundSideEffects;
|
|
4889
5071
|
}
|
|
4890
|
-
interface
|
|
5072
|
+
interface PaymentRefund {
|
|
4891
5073
|
/**
|
|
4892
|
-
*
|
|
5074
|
+
* Specific payment within the order to refund
|
|
4893
5075
|
* @format GUID
|
|
4894
5076
|
*/
|
|
4895
|
-
|
|
4896
|
-
/**
|
|
4897
|
-
|
|
5077
|
+
paymentId?: string;
|
|
5078
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5079
|
+
amount?: Price;
|
|
5080
|
+
/**
|
|
5081
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5082
|
+
* 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.
|
|
5083
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5084
|
+
*/
|
|
5085
|
+
externalRefund?: boolean;
|
|
4898
5086
|
}
|
|
4899
|
-
interface
|
|
5087
|
+
interface RefundSideEffects {
|
|
5088
|
+
/** Inventory restock details as part of this refund. */
|
|
5089
|
+
restockInfo?: RestockInfo;
|
|
5090
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
5091
|
+
sendOrderRefundedEmail?: boolean;
|
|
4900
5092
|
/**
|
|
4901
|
-
*
|
|
5093
|
+
* Custom message added to the refund confirmation email.
|
|
4902
5094
|
* @minLength 1
|
|
4903
|
-
* @maxLength
|
|
5095
|
+
* @maxLength 1000
|
|
4904
5096
|
*/
|
|
4905
|
-
|
|
5097
|
+
customMessage?: string | null;
|
|
5098
|
+
}
|
|
5099
|
+
interface RestockInfo {
|
|
5100
|
+
/** Restock type. */
|
|
5101
|
+
type?: RestockTypeWithLiterals;
|
|
4906
5102
|
/**
|
|
4907
|
-
*
|
|
5103
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
4908
5104
|
* @maxSize 300
|
|
4909
5105
|
*/
|
|
4910
|
-
|
|
4911
|
-
/** Should include shipping in refund calculation */
|
|
4912
|
-
refundShipping?: boolean;
|
|
5106
|
+
items?: RestockItem[];
|
|
4913
5107
|
}
|
|
4914
|
-
|
|
5108
|
+
declare enum RestockType {
|
|
5109
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5110
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5111
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5112
|
+
}
|
|
5113
|
+
/** @enumType */
|
|
5114
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5115
|
+
interface RestockItem {
|
|
4915
5116
|
/**
|
|
4916
|
-
* ID of the line item being
|
|
5117
|
+
* ID of the line item being restocked.
|
|
4917
5118
|
* @format GUID
|
|
4918
5119
|
*/
|
|
4919
|
-
|
|
5120
|
+
lineItemId?: string;
|
|
4920
5121
|
/**
|
|
4921
|
-
*
|
|
5122
|
+
* Line item quantity being restocked.
|
|
4922
5123
|
* @min 1
|
|
4923
5124
|
* @max 100000
|
|
4924
5125
|
*/
|
|
4925
5126
|
quantity?: number;
|
|
4926
5127
|
}
|
|
4927
|
-
interface
|
|
4928
|
-
/**
|
|
4929
|
-
|
|
4930
|
-
/**
|
|
4931
|
-
|
|
4932
|
-
/**
|
|
4933
|
-
|
|
4934
|
-
|
|
4935
|
-
|
|
4936
|
-
|
|
4937
|
-
|
|
4938
|
-
|
|
4939
|
-
|
|
5128
|
+
interface TriggerRefundResponse {
|
|
5129
|
+
/** All order's transactions after the refunds were added */
|
|
5130
|
+
orderTransactions?: OrderTransactions;
|
|
5131
|
+
/** Created refund ID */
|
|
5132
|
+
refundId?: string | null;
|
|
5133
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5134
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5135
|
+
}
|
|
5136
|
+
/**
|
|
5137
|
+
* A record of all payments and refunds associated with an order.
|
|
5138
|
+
*
|
|
5139
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5140
|
+
*/
|
|
5141
|
+
interface OrderTransactions {
|
|
4940
5142
|
/**
|
|
4941
|
-
*
|
|
5143
|
+
* Order ID.
|
|
5144
|
+
* @format GUID
|
|
5145
|
+
*/
|
|
5146
|
+
orderId?: string;
|
|
5147
|
+
/**
|
|
5148
|
+
* Record of payments made to the merchant.
|
|
5149
|
+
* @maxSize 100
|
|
5150
|
+
*/
|
|
5151
|
+
payments?: Payment[];
|
|
5152
|
+
/**
|
|
5153
|
+
* Record of refunds made to the buyer.
|
|
4942
5154
|
* @maxSize 300
|
|
4943
5155
|
*/
|
|
4944
|
-
|
|
5156
|
+
refunds?: Refund[];
|
|
4945
5157
|
}
|
|
4946
|
-
interface
|
|
5158
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
5159
|
+
/** Regular payment details. */
|
|
5160
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5161
|
+
/** Gift card payment details. */
|
|
5162
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4947
5163
|
/**
|
|
4948
|
-
*
|
|
5164
|
+
* Payment ID.
|
|
4949
5165
|
* @format GUID
|
|
5166
|
+
* @readonly
|
|
4950
5167
|
*/
|
|
4951
|
-
id?: string;
|
|
4952
|
-
/**
|
|
4953
|
-
|
|
5168
|
+
id?: string | null;
|
|
5169
|
+
/** 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. */
|
|
5170
|
+
createdDate?: Date | null;
|
|
5171
|
+
/**
|
|
5172
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5173
|
+
* @readonly
|
|
5174
|
+
*/
|
|
5175
|
+
updatedDate?: Date | null;
|
|
5176
|
+
/** Payment amount. */
|
|
5177
|
+
amount?: Price;
|
|
5178
|
+
/**
|
|
5179
|
+
* Whether refunds for this payment are disabled.
|
|
5180
|
+
* + `true`: This payment is not refundable.
|
|
5181
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5182
|
+
*/
|
|
5183
|
+
refundDisabled?: boolean;
|
|
4954
5184
|
}
|
|
4955
|
-
|
|
5185
|
+
/** @oneof */
|
|
5186
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5187
|
+
/** Regular payment details. */
|
|
5188
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5189
|
+
/** Gift card payment details. */
|
|
5190
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5191
|
+
}
|
|
5192
|
+
/** @oneof */
|
|
5193
|
+
interface PaymentReceiptInfoOneOf {
|
|
5194
|
+
}
|
|
5195
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5196
|
+
/** Credit card details. */
|
|
5197
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4956
5198
|
/**
|
|
4957
|
-
* Wix
|
|
4958
|
-
* @minLength 1
|
|
5199
|
+
* Wix Payments order ID.
|
|
4959
5200
|
* @maxLength 100
|
|
4960
5201
|
*/
|
|
4961
|
-
|
|
5202
|
+
paymentOrderId?: string | null;
|
|
4962
5203
|
/**
|
|
4963
|
-
* Payment
|
|
4964
|
-
*
|
|
4965
|
-
* @
|
|
4966
|
-
* @format GUID
|
|
5204
|
+
* Payment gateway's transaction ID.
|
|
5205
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5206
|
+
* @maxLength 100
|
|
4967
5207
|
*/
|
|
4968
|
-
|
|
5208
|
+
gatewayTransactionId?: string | null;
|
|
5209
|
+
/**
|
|
5210
|
+
* Payment method.
|
|
5211
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5212
|
+
* Non-exhaustive list of supported values:
|
|
5213
|
+
* + `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`
|
|
5214
|
+
* @maxLength 100
|
|
5215
|
+
* @deprecated Payment method.
|
|
5216
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5217
|
+
* Non-exhaustive list of supported values:
|
|
5218
|
+
* + `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`
|
|
5219
|
+
* @replacedBy payment_method_name
|
|
5220
|
+
* @targetRemovalDate 2026-07-01
|
|
5221
|
+
*/
|
|
5222
|
+
paymentMethod?: string | null;
|
|
5223
|
+
/**
|
|
5224
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5225
|
+
* @maxLength 100
|
|
5226
|
+
*/
|
|
5227
|
+
providerTransactionId?: string | null;
|
|
5228
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5229
|
+
offlinePayment?: boolean;
|
|
5230
|
+
/** Payment status. */
|
|
5231
|
+
status?: TransactionStatusWithLiterals;
|
|
5232
|
+
/**
|
|
5233
|
+
* Whether there is a payment agreement that allows for future charges.
|
|
5234
|
+
* @immutable
|
|
5235
|
+
*/
|
|
5236
|
+
savedPaymentMethod?: boolean;
|
|
5237
|
+
/** Authorization details. */
|
|
5238
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5239
|
+
/**
|
|
5240
|
+
* Record of chargebacks made by the buyer.
|
|
5241
|
+
* @maxSize 6
|
|
5242
|
+
*/
|
|
5243
|
+
chargebacks?: Chargeback[];
|
|
5244
|
+
/** Platform fee amount associated with this payment. */
|
|
5245
|
+
platformFee?: Price;
|
|
5246
|
+
/**
|
|
5247
|
+
* Payment method with buyer and optional owner translations.
|
|
5248
|
+
* Non-exhaustive list of supported values:
|
|
5249
|
+
* + `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`
|
|
5250
|
+
*/
|
|
5251
|
+
paymentMethodName?: PaymentMethodName;
|
|
4969
5252
|
}
|
|
4970
|
-
|
|
4971
|
-
|
|
4972
|
-
|
|
5253
|
+
/** @oneof */
|
|
5254
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5255
|
+
/** Credit card details. */
|
|
5256
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4973
5257
|
}
|
|
4974
|
-
|
|
5258
|
+
declare enum TransactionStatus {
|
|
5259
|
+
UNDEFINED = "UNDEFINED",
|
|
5260
|
+
APPROVED = "APPROVED",
|
|
5261
|
+
PENDING = "PENDING",
|
|
5262
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5263
|
+
CANCELED = "CANCELED",
|
|
5264
|
+
DECLINED = "DECLINED",
|
|
5265
|
+
REFUNDED = "REFUNDED",
|
|
5266
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5267
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5268
|
+
VOIDED = "VOIDED"
|
|
5269
|
+
}
|
|
5270
|
+
/** @enumType */
|
|
5271
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5272
|
+
interface CreditCardPaymentMethodDetails {
|
|
4975
5273
|
/**
|
|
4976
|
-
*
|
|
4977
|
-
* @
|
|
5274
|
+
* The last 4 digits of the card number.
|
|
5275
|
+
* @maxLength 4
|
|
5276
|
+
*/
|
|
5277
|
+
lastFourDigits?: string | null;
|
|
5278
|
+
/**
|
|
5279
|
+
* Card issuer's brand.
|
|
4978
5280
|
* @maxLength 100
|
|
4979
5281
|
*/
|
|
4980
|
-
|
|
5282
|
+
brand?: string | null;
|
|
5283
|
+
}
|
|
5284
|
+
interface AuthorizationDetails {
|
|
4981
5285
|
/**
|
|
4982
|
-
*
|
|
4983
|
-
* @
|
|
4984
|
-
* @maxSize 100
|
|
5286
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5287
|
+
* @readonly
|
|
4985
5288
|
*/
|
|
4986
|
-
|
|
5289
|
+
delayedCapture?: boolean;
|
|
5290
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5291
|
+
authorizedDate?: Date | null;
|
|
5292
|
+
/**
|
|
5293
|
+
* List of captures associated with payment
|
|
5294
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5295
|
+
* @maxSize 1
|
|
5296
|
+
*/
|
|
5297
|
+
captures?: AuthorizationCapture[];
|
|
5298
|
+
/** Void associated with payment */
|
|
5299
|
+
void?: AuthorizationVoid;
|
|
5300
|
+
/** Scheduled action for this transaction */
|
|
5301
|
+
scheduledAction?: V1ScheduledAction;
|
|
4987
5302
|
}
|
|
4988
|
-
interface
|
|
5303
|
+
interface AuthorizationCapture {
|
|
4989
5304
|
/**
|
|
4990
|
-
*
|
|
5305
|
+
* Capture ID.
|
|
4991
5306
|
* @format GUID
|
|
5307
|
+
* @readonly
|
|
4992
5308
|
*/
|
|
4993
|
-
|
|
4994
|
-
/**
|
|
4995
|
-
|
|
4996
|
-
* If not provided - full authorized amount will be captured.
|
|
4997
|
-
*/
|
|
4998
|
-
amount?: Price;
|
|
4999
|
-
}
|
|
5000
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
5001
|
-
/** All order's transactions after the capture was triggered */
|
|
5002
|
-
orderTransactions?: OrderTransactions;
|
|
5003
|
-
}
|
|
5004
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
5309
|
+
id?: string | null;
|
|
5310
|
+
/** Status of this capture action */
|
|
5311
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5005
5312
|
/**
|
|
5006
|
-
*
|
|
5007
|
-
* @
|
|
5008
|
-
* @maxLength 100
|
|
5313
|
+
* Amount of this capture
|
|
5314
|
+
* @immutable
|
|
5009
5315
|
*/
|
|
5010
|
-
ecomOrderId?: string;
|
|
5011
|
-
/** Amount to be charged */
|
|
5012
5316
|
amount?: Price;
|
|
5317
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5318
|
+
createdDate?: Date | null;
|
|
5319
|
+
/** In case of status is FAILED may contain failure details */
|
|
5320
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5013
5321
|
}
|
|
5014
|
-
|
|
5015
|
-
/**
|
|
5016
|
-
|
|
5322
|
+
declare enum AuthorizationCaptureStatus {
|
|
5323
|
+
/** Capture operation still in progress. */
|
|
5324
|
+
PENDING = "PENDING",
|
|
5325
|
+
/** Capture operation succeeded. */
|
|
5326
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5327
|
+
/** Capture operation failed. */
|
|
5328
|
+
FAILED = "FAILED"
|
|
5017
5329
|
}
|
|
5018
|
-
|
|
5019
|
-
|
|
5020
|
-
|
|
5330
|
+
/** @enumType */
|
|
5331
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5332
|
+
interface AuthorizationActionFailureDetails {
|
|
5333
|
+
/** @maxLength 100 */
|
|
5334
|
+
failureCode?: string;
|
|
5021
5335
|
}
|
|
5022
|
-
interface
|
|
5336
|
+
interface AuthorizationVoid {
|
|
5337
|
+
/** Status of this void action */
|
|
5338
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5339
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5340
|
+
voidedDate?: Date | null;
|
|
5341
|
+
/** In case of status is FAILED may contain failure details */
|
|
5342
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5343
|
+
/** Reason of void action */
|
|
5344
|
+
reason?: ReasonWithLiterals;
|
|
5023
5345
|
}
|
|
5024
|
-
|
|
5025
|
-
/**
|
|
5026
|
-
|
|
5027
|
-
|
|
5028
|
-
|
|
5029
|
-
|
|
5346
|
+
declare enum AuthorizationVoidStatus {
|
|
5347
|
+
/** Void operation still in progress. */
|
|
5348
|
+
PENDING = "PENDING",
|
|
5349
|
+
/** Void operation succeeded. */
|
|
5350
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5351
|
+
/** Void operation failed. */
|
|
5352
|
+
FAILED = "FAILED"
|
|
5030
5353
|
}
|
|
5031
|
-
|
|
5354
|
+
/** @enumType */
|
|
5355
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5356
|
+
/** Reason the authorization was voided. */
|
|
5357
|
+
declare enum Reason {
|
|
5358
|
+
/** Authorization was voided by user. */
|
|
5359
|
+
MANUAL = "MANUAL",
|
|
5360
|
+
/** Authorization passed execution date. */
|
|
5361
|
+
SCHEDULED = "SCHEDULED"
|
|
5032
5362
|
}
|
|
5033
|
-
|
|
5034
|
-
|
|
5035
|
-
|
|
5036
|
-
|
|
5037
|
-
|
|
5038
|
-
|
|
5363
|
+
/** @enumType */
|
|
5364
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5365
|
+
interface V1ScheduledAction {
|
|
5366
|
+
/** Type of the action. */
|
|
5367
|
+
actionType?: ActionTypeWithLiterals;
|
|
5368
|
+
/** The date and time of the action. */
|
|
5369
|
+
executionDate?: Date | null;
|
|
5039
5370
|
}
|
|
5040
|
-
|
|
5371
|
+
declare enum ActionType {
|
|
5372
|
+
VOID = "VOID",
|
|
5373
|
+
CAPTURE = "CAPTURE"
|
|
5041
5374
|
}
|
|
5042
|
-
|
|
5375
|
+
/** @enumType */
|
|
5376
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5377
|
+
interface Chargeback {
|
|
5043
5378
|
/**
|
|
5044
|
-
*
|
|
5045
|
-
* @
|
|
5046
|
-
* @
|
|
5379
|
+
* Chargeback ID.
|
|
5380
|
+
* @format GUID
|
|
5381
|
+
* @readonly
|
|
5382
|
+
* @immutable
|
|
5047
5383
|
*/
|
|
5048
|
-
|
|
5049
|
-
}
|
|
5050
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5051
|
-
}
|
|
5052
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
5384
|
+
id?: string;
|
|
5053
5385
|
/**
|
|
5054
|
-
*
|
|
5055
|
-
* @
|
|
5386
|
+
* 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.
|
|
5387
|
+
* @readonly
|
|
5388
|
+
* @immutable
|
|
5056
5389
|
*/
|
|
5057
|
-
|
|
5058
|
-
}
|
|
5059
|
-
interface SendBuyerShippingConfirmationEmailResponse {
|
|
5060
|
-
}
|
|
5061
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
5390
|
+
createdDate?: Date | null;
|
|
5062
5391
|
/**
|
|
5063
|
-
*
|
|
5064
|
-
* @
|
|
5065
|
-
* @maxSize 300
|
|
5392
|
+
* 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.
|
|
5393
|
+
* @readonly
|
|
5066
5394
|
*/
|
|
5067
|
-
|
|
5068
|
-
}
|
|
5069
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
5070
|
-
}
|
|
5071
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
5395
|
+
updatedDate?: Date | null;
|
|
5072
5396
|
/**
|
|
5073
|
-
*
|
|
5074
|
-
* @
|
|
5397
|
+
* Amount.
|
|
5398
|
+
* @readonly
|
|
5399
|
+
* @immutable
|
|
5075
5400
|
*/
|
|
5076
|
-
|
|
5077
|
-
}
|
|
5078
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5079
|
-
}
|
|
5080
|
-
interface SendCancelRefundEmailRequest {
|
|
5401
|
+
amount?: Price;
|
|
5081
5402
|
/**
|
|
5082
|
-
*
|
|
5083
|
-
* @
|
|
5084
|
-
* @maxLength 100
|
|
5403
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5404
|
+
* @readonly
|
|
5085
5405
|
*/
|
|
5086
|
-
|
|
5406
|
+
reversalAmount?: Price;
|
|
5087
5407
|
/**
|
|
5088
|
-
*
|
|
5089
|
-
*
|
|
5090
|
-
*
|
|
5408
|
+
* Status.
|
|
5409
|
+
*
|
|
5410
|
+
* Default: `"APPROVED"`.
|
|
5091
5411
|
*/
|
|
5092
|
-
|
|
5093
|
-
/** Refund amount */
|
|
5094
|
-
refundAmount?: Price;
|
|
5412
|
+
status?: ChargebackStatusWithLiterals;
|
|
5095
5413
|
/**
|
|
5096
|
-
*
|
|
5414
|
+
* External chargeback ID.
|
|
5097
5415
|
* @format GUID
|
|
5416
|
+
* @readonly
|
|
5417
|
+
* @immutable
|
|
5098
5418
|
*/
|
|
5099
|
-
|
|
5419
|
+
externalId?: string | null;
|
|
5100
5420
|
}
|
|
5101
|
-
|
|
5421
|
+
declare enum ChargebackStatus {
|
|
5422
|
+
/** Chargeback was approved. */
|
|
5423
|
+
APPROVED = "APPROVED",
|
|
5424
|
+
/** Chargeback was reversed. */
|
|
5425
|
+
REVERSED = "REVERSED"
|
|
5102
5426
|
}
|
|
5103
|
-
|
|
5104
|
-
|
|
5105
|
-
|
|
5106
|
-
* @format GUID
|
|
5107
|
-
*/
|
|
5108
|
-
orderId?: string;
|
|
5427
|
+
/** @enumType */
|
|
5428
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5429
|
+
interface PaymentMethodName {
|
|
5109
5430
|
/**
|
|
5110
|
-
*
|
|
5111
|
-
* @
|
|
5431
|
+
* Translated payment method name in buyer language.
|
|
5432
|
+
* @maxLength 100
|
|
5112
5433
|
*/
|
|
5113
|
-
|
|
5434
|
+
buyerLanguageName?: string | null;
|
|
5114
5435
|
/**
|
|
5115
|
-
*
|
|
5116
|
-
* @
|
|
5117
|
-
* @maxLength 1000
|
|
5436
|
+
* Translated payment method name in site owner language.
|
|
5437
|
+
* @maxLength 100
|
|
5118
5438
|
*/
|
|
5119
|
-
|
|
5120
|
-
}
|
|
5121
|
-
interface SendRefundEmailResponse {
|
|
5122
|
-
}
|
|
5123
|
-
interface SendFulfillmentEmailRequest {
|
|
5124
|
-
/** @format GUID */
|
|
5125
|
-
orderId?: string;
|
|
5126
|
-
/** @format GUID */
|
|
5127
|
-
fulfillerId?: string;
|
|
5128
|
-
}
|
|
5129
|
-
interface SendFulfillmentEmailResponse {
|
|
5130
|
-
}
|
|
5131
|
-
interface SendMerchantOrderReceivedPushRequest {
|
|
5439
|
+
siteLanguageName?: string | null;
|
|
5132
5440
|
/**
|
|
5133
|
-
*
|
|
5134
|
-
*
|
|
5441
|
+
* User-provided payment method name.
|
|
5442
|
+
*
|
|
5443
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5135
5444
|
*/
|
|
5136
|
-
|
|
5137
|
-
}
|
|
5138
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
5139
|
-
}
|
|
5140
|
-
interface PreviewEmailByTypeRequest {
|
|
5141
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
5142
|
-
}
|
|
5143
|
-
declare enum PreviewEmailType {
|
|
5144
|
-
ORDER_PLACED = "ORDER_PLACED",
|
|
5145
|
-
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
5146
|
-
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
5147
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
5148
|
-
}
|
|
5149
|
-
/** @enumType */
|
|
5150
|
-
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
5151
|
-
interface PreviewEmailByTypeResponse {
|
|
5152
|
-
emailPreview?: string;
|
|
5445
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5153
5446
|
}
|
|
5154
|
-
interface
|
|
5447
|
+
interface GiftCardPaymentDetails {
|
|
5155
5448
|
/**
|
|
5156
|
-
*
|
|
5449
|
+
* Gift card payment ID.
|
|
5157
5450
|
* @maxLength 100
|
|
5158
5451
|
*/
|
|
5159
|
-
|
|
5160
|
-
/** Refund amount */
|
|
5161
|
-
refundAmount?: Price;
|
|
5162
|
-
/** Refund business details */
|
|
5163
|
-
details?: RefundDetails;
|
|
5452
|
+
giftCardPaymentId?: string;
|
|
5164
5453
|
/**
|
|
5165
|
-
*
|
|
5166
|
-
* @
|
|
5167
|
-
* @maxLength 1000
|
|
5454
|
+
* ID of the app that created the gift card.
|
|
5455
|
+
* @format GUID
|
|
5168
5456
|
*/
|
|
5169
|
-
|
|
5457
|
+
appId?: string;
|
|
5170
5458
|
/**
|
|
5171
|
-
*
|
|
5172
|
-
* @
|
|
5459
|
+
* Whether the gift card is voided.
|
|
5460
|
+
* @readonly
|
|
5173
5461
|
*/
|
|
5174
|
-
|
|
5175
|
-
}
|
|
5176
|
-
interface PreviewRefundEmailResponse {
|
|
5177
|
-
emailPreview?: string;
|
|
5462
|
+
voided?: boolean;
|
|
5178
5463
|
}
|
|
5179
|
-
interface
|
|
5464
|
+
interface MembershipPaymentDetails {
|
|
5180
5465
|
/**
|
|
5466
|
+
* Membership ID.
|
|
5181
5467
|
* @minLength 1
|
|
5182
5468
|
* @maxLength 100
|
|
5183
5469
|
*/
|
|
5184
|
-
|
|
5470
|
+
membershipId?: string;
|
|
5185
5471
|
/**
|
|
5186
|
-
*
|
|
5472
|
+
* ID of the line item this membership applies to.
|
|
5187
5473
|
* @minLength 1
|
|
5188
|
-
* @maxLength
|
|
5474
|
+
* @maxLength 100
|
|
5189
5475
|
*/
|
|
5190
|
-
|
|
5191
|
-
|
|
5192
|
-
|
|
5193
|
-
|
|
5194
|
-
|
|
5195
|
-
interface PreviewCancelRefundEmailRequest {
|
|
5476
|
+
lineItemId?: string;
|
|
5477
|
+
/** Payment status. */
|
|
5478
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5479
|
+
/** Membership name. */
|
|
5480
|
+
name?: MembershipName;
|
|
5196
5481
|
/**
|
|
5482
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5197
5483
|
* @minLength 1
|
|
5198
5484
|
* @maxLength 100
|
|
5199
5485
|
*/
|
|
5200
|
-
|
|
5486
|
+
externalTransactionId?: string | null;
|
|
5201
5487
|
/**
|
|
5202
|
-
*
|
|
5203
|
-
* @
|
|
5204
|
-
* @maxLength 1000
|
|
5488
|
+
* Whether the membership is voided.
|
|
5489
|
+
* @readonly
|
|
5205
5490
|
*/
|
|
5206
|
-
|
|
5207
|
-
/** Refund amount */
|
|
5208
|
-
refundAmount?: Price;
|
|
5491
|
+
voided?: boolean;
|
|
5209
5492
|
/**
|
|
5210
|
-
*
|
|
5493
|
+
* ID of the application providing this payment option.
|
|
5211
5494
|
* @format GUID
|
|
5212
5495
|
*/
|
|
5213
|
-
|
|
5214
|
-
}
|
|
5215
|
-
interface PreviewCancelRefundEmailResponse {
|
|
5216
|
-
emailPreview?: string;
|
|
5217
|
-
}
|
|
5218
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
5219
|
-
}
|
|
5220
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5221
|
-
emailPreview?: string;
|
|
5222
|
-
}
|
|
5223
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
5224
|
-
}
|
|
5225
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
5226
|
-
emailPreview?: string;
|
|
5227
|
-
}
|
|
5228
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
5229
|
-
}
|
|
5230
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
5231
|
-
emailPreview?: string;
|
|
5232
|
-
}
|
|
5233
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
5234
|
-
}
|
|
5235
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
5236
|
-
emailPreview?: string;
|
|
5237
|
-
}
|
|
5238
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
5496
|
+
providerAppId?: string;
|
|
5239
5497
|
}
|
|
5240
|
-
|
|
5241
|
-
|
|
5498
|
+
declare enum MembershipPaymentStatus {
|
|
5499
|
+
/** Payment was charged. */
|
|
5500
|
+
CHARGED = "CHARGED",
|
|
5501
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5502
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5503
|
+
/** Payment is pending. */
|
|
5504
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5505
|
+
/** Payment was voided. */
|
|
5506
|
+
VOIDED = "VOIDED"
|
|
5242
5507
|
}
|
|
5243
|
-
|
|
5244
|
-
|
|
5245
|
-
|
|
5246
|
-
/** Emitted on a meta site transfer completion. */
|
|
5247
|
-
siteTransferred?: SiteTransferred;
|
|
5248
|
-
/** Emitted on a meta site deletion. */
|
|
5249
|
-
siteDeleted?: SiteDeleted;
|
|
5250
|
-
/** Emitted on a meta site restoration. */
|
|
5251
|
-
siteUndeleted?: SiteUndeleted;
|
|
5252
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5253
|
-
sitePublished?: SitePublished;
|
|
5254
|
-
/** Emitted on a meta site unpublish. */
|
|
5255
|
-
siteUnpublished?: SiteUnpublished;
|
|
5256
|
-
/** Emitted when meta site is marked as template. */
|
|
5257
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5258
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5259
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5260
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5261
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5262
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5263
|
-
serviceRemoved?: ServiceRemoved;
|
|
5264
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5265
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5266
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5267
|
-
hardDeleted?: SiteHardDeleted;
|
|
5268
|
-
/** Emitted on a namespace change. */
|
|
5269
|
-
namespaceChanged?: NamespaceChanged;
|
|
5270
|
-
/** Emitted when Studio is attached. */
|
|
5271
|
-
studioAssigned?: StudioAssigned;
|
|
5272
|
-
/** Emitted when Studio is detached. */
|
|
5273
|
-
studioUnassigned?: StudioUnassigned;
|
|
5274
|
-
/**
|
|
5275
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5276
|
-
* the actual URL.
|
|
5277
|
-
*
|
|
5278
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5279
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5280
|
-
*/
|
|
5281
|
-
urlChanged?: SiteUrlChanged;
|
|
5282
|
-
/** Site is marked as PurgedExternally */
|
|
5283
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5284
|
-
/** Emitted when Odeditor is attached. */
|
|
5285
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5286
|
-
/** Emitted when Odeditor is detached. */
|
|
5287
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5288
|
-
/** Emitted when Picasso is attached. */
|
|
5289
|
-
picassoAssigned?: PicassoAssigned;
|
|
5290
|
-
/** Emitted when Picasso is detached. */
|
|
5291
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5292
|
-
/** Emitted when Wixel is attached. */
|
|
5293
|
-
wixelAssigned?: WixelAssigned;
|
|
5294
|
-
/** Emitted when Wixel is detached. */
|
|
5295
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5296
|
-
/** Emitted when StudioTwo is attached. */
|
|
5297
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5298
|
-
/** Emitted when StudioTwo is detached. */
|
|
5299
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5300
|
-
/** Emitted when media from user domain is enabled. */
|
|
5301
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5302
|
-
/** Emitted when media from user domain is disabled. */
|
|
5303
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5304
|
-
/** Emitted when Editorless is attached. */
|
|
5305
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5306
|
-
/** Emitted when Editorless is detached. */
|
|
5307
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5508
|
+
/** @enumType */
|
|
5509
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5510
|
+
interface WixReceiptInfo {
|
|
5308
5511
|
/**
|
|
5309
|
-
*
|
|
5512
|
+
* Receipt ID
|
|
5310
5513
|
* @format GUID
|
|
5311
5514
|
*/
|
|
5312
|
-
|
|
5313
|
-
/** A meta site version. Monotonically increasing. */
|
|
5314
|
-
version?: string;
|
|
5315
|
-
/** A timestamp of the event. */
|
|
5316
|
-
timestamp?: string;
|
|
5317
|
-
/**
|
|
5318
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
5319
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
5320
|
-
* @maxSize 4000
|
|
5321
|
-
*/
|
|
5322
|
-
assets?: Asset[];
|
|
5323
|
-
}
|
|
5324
|
-
/** @oneof */
|
|
5325
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5326
|
-
/** Emitted on a meta site creation. */
|
|
5327
|
-
siteCreated?: SiteCreated;
|
|
5328
|
-
/** Emitted on a meta site transfer completion. */
|
|
5329
|
-
siteTransferred?: SiteTransferred;
|
|
5330
|
-
/** Emitted on a meta site deletion. */
|
|
5331
|
-
siteDeleted?: SiteDeleted;
|
|
5332
|
-
/** Emitted on a meta site restoration. */
|
|
5333
|
-
siteUndeleted?: SiteUndeleted;
|
|
5334
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5335
|
-
sitePublished?: SitePublished;
|
|
5336
|
-
/** Emitted on a meta site unpublish. */
|
|
5337
|
-
siteUnpublished?: SiteUnpublished;
|
|
5338
|
-
/** Emitted when meta site is marked as template. */
|
|
5339
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5340
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5341
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5342
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5343
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5344
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5345
|
-
serviceRemoved?: ServiceRemoved;
|
|
5346
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5347
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5348
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5349
|
-
hardDeleted?: SiteHardDeleted;
|
|
5350
|
-
/** Emitted on a namespace change. */
|
|
5351
|
-
namespaceChanged?: NamespaceChanged;
|
|
5352
|
-
/** Emitted when Studio is attached. */
|
|
5353
|
-
studioAssigned?: StudioAssigned;
|
|
5354
|
-
/** Emitted when Studio is detached. */
|
|
5355
|
-
studioUnassigned?: StudioUnassigned;
|
|
5356
|
-
/**
|
|
5357
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5358
|
-
* the actual URL.
|
|
5359
|
-
*
|
|
5360
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5361
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5362
|
-
*/
|
|
5363
|
-
urlChanged?: SiteUrlChanged;
|
|
5364
|
-
/** Site is marked as PurgedExternally */
|
|
5365
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5366
|
-
/** Emitted when Odeditor is attached. */
|
|
5367
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5368
|
-
/** Emitted when Odeditor is detached. */
|
|
5369
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5370
|
-
/** Emitted when Picasso is attached. */
|
|
5371
|
-
picassoAssigned?: PicassoAssigned;
|
|
5372
|
-
/** Emitted when Picasso is detached. */
|
|
5373
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5374
|
-
/** Emitted when Wixel is attached. */
|
|
5375
|
-
wixelAssigned?: WixelAssigned;
|
|
5376
|
-
/** Emitted when Wixel is detached. */
|
|
5377
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5378
|
-
/** Emitted when StudioTwo is attached. */
|
|
5379
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5380
|
-
/** Emitted when StudioTwo is detached. */
|
|
5381
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5382
|
-
/** Emitted when media from user domain is enabled. */
|
|
5383
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5384
|
-
/** Emitted when media from user domain is disabled. */
|
|
5385
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5386
|
-
/** Emitted when Editorless is attached. */
|
|
5387
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5388
|
-
/** Emitted when Editorless is detached. */
|
|
5389
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5390
|
-
}
|
|
5391
|
-
interface Asset {
|
|
5392
|
-
/**
|
|
5393
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
5394
|
-
* @maxLength 36
|
|
5395
|
-
*/
|
|
5396
|
-
appDefId?: string;
|
|
5397
|
-
/**
|
|
5398
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
5399
|
-
* @maxLength 200
|
|
5400
|
-
*/
|
|
5401
|
-
instanceId?: string;
|
|
5402
|
-
/** An application state. */
|
|
5403
|
-
state?: StateWithLiterals;
|
|
5404
|
-
}
|
|
5405
|
-
declare enum State {
|
|
5406
|
-
UNKNOWN = "UNKNOWN",
|
|
5407
|
-
ENABLED = "ENABLED",
|
|
5408
|
-
DISABLED = "DISABLED",
|
|
5409
|
-
PENDING = "PENDING",
|
|
5410
|
-
DEMO = "DEMO"
|
|
5411
|
-
}
|
|
5412
|
-
/** @enumType */
|
|
5413
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5414
|
-
interface SiteCreated {
|
|
5515
|
+
receiptId?: string;
|
|
5415
5516
|
/**
|
|
5416
|
-
*
|
|
5417
|
-
* @
|
|
5517
|
+
* Display number of receipt
|
|
5518
|
+
* @minLength 1
|
|
5519
|
+
* @maxLength 40
|
|
5418
5520
|
*/
|
|
5419
|
-
|
|
5521
|
+
displayNumber?: string | null;
|
|
5522
|
+
}
|
|
5523
|
+
interface ExternalReceiptInfo {
|
|
5420
5524
|
/**
|
|
5421
|
-
*
|
|
5422
|
-
* @
|
|
5525
|
+
* External receipt ID
|
|
5526
|
+
* @maxLength 100
|
|
5423
5527
|
*/
|
|
5424
|
-
|
|
5425
|
-
/** A context in which meta site was created. */
|
|
5426
|
-
context?: SiteCreatedContextWithLiterals;
|
|
5528
|
+
receiptId?: string | null;
|
|
5427
5529
|
/**
|
|
5428
|
-
*
|
|
5429
|
-
*
|
|
5430
|
-
* In case of a creation from a template it's a template id.
|
|
5431
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5530
|
+
* ID of the app providing the receipt
|
|
5432
5531
|
* @format GUID
|
|
5433
5532
|
*/
|
|
5434
|
-
|
|
5533
|
+
appId?: string | null;
|
|
5435
5534
|
/**
|
|
5436
|
-
*
|
|
5437
|
-
* @
|
|
5535
|
+
* Display number of receipt
|
|
5536
|
+
* @minLength 1
|
|
5537
|
+
* @maxLength 40
|
|
5438
5538
|
*/
|
|
5439
|
-
|
|
5440
|
-
/** A namespace. */
|
|
5441
|
-
namespace?: NamespaceWithLiterals;
|
|
5539
|
+
displayNumber?: string | null;
|
|
5442
5540
|
}
|
|
5443
|
-
|
|
5444
|
-
|
|
5445
|
-
|
|
5446
|
-
|
|
5447
|
-
|
|
5448
|
-
|
|
5449
|
-
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
|
|
5454
|
-
|
|
5455
|
-
FLASH = "FLASH"
|
|
5541
|
+
interface CashRoundingDetails {
|
|
5542
|
+
}
|
|
5543
|
+
declare enum PaymentStatus {
|
|
5544
|
+
APPROVED = "APPROVED",
|
|
5545
|
+
PENDING = "PENDING",
|
|
5546
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5547
|
+
CANCELED = "CANCELED",
|
|
5548
|
+
DECLINED = "DECLINED",
|
|
5549
|
+
REFUNDED = "REFUNDED",
|
|
5550
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5551
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5552
|
+
VOIDED = "VOIDED"
|
|
5456
5553
|
}
|
|
5457
5554
|
/** @enumType */
|
|
5458
|
-
type
|
|
5459
|
-
|
|
5460
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5461
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5462
|
-
WIX = "WIX",
|
|
5463
|
-
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5464
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
5465
|
-
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5466
|
-
ALBUMS = "ALBUMS",
|
|
5467
|
-
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5468
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5469
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5470
|
-
HOTELS = "HOTELS",
|
|
5471
|
-
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5472
|
-
CLUBS = "CLUBS",
|
|
5473
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5474
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5475
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5476
|
-
DEV_SITE = "DEV_SITE",
|
|
5477
|
-
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5478
|
-
LOGOS = "LOGOS",
|
|
5479
|
-
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5480
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5481
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5482
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5483
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5484
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5485
|
-
/**
|
|
5486
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5487
|
-
*
|
|
5488
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5489
|
-
*/
|
|
5490
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
5555
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5556
|
+
interface Refund {
|
|
5491
5557
|
/**
|
|
5492
|
-
*
|
|
5493
|
-
*
|
|
5494
|
-
*
|
|
5558
|
+
* Refund ID.
|
|
5559
|
+
* @format GUID
|
|
5560
|
+
* @readonly
|
|
5495
5561
|
*/
|
|
5496
|
-
|
|
5497
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5498
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5499
|
-
/** It is to be used in the Business First efforts. */
|
|
5500
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5501
|
-
/** Bookings business flow with no site. */
|
|
5502
|
-
ANYWHERE = "ANYWHERE",
|
|
5503
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
5504
|
-
HEADLESS = "HEADLESS",
|
|
5562
|
+
id?: string;
|
|
5505
5563
|
/**
|
|
5506
|
-
*
|
|
5507
|
-
*
|
|
5564
|
+
* List of transactions.
|
|
5565
|
+
* @maxSize 50
|
|
5508
5566
|
*/
|
|
5509
|
-
|
|
5510
|
-
/**
|
|
5511
|
-
|
|
5567
|
+
transactions?: RefundTransaction[];
|
|
5568
|
+
/** Refund business details. */
|
|
5569
|
+
details?: RefundDetails;
|
|
5512
5570
|
/**
|
|
5513
|
-
*
|
|
5514
|
-
*
|
|
5515
|
-
*
|
|
5571
|
+
* 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.
|
|
5572
|
+
* @readonly
|
|
5573
|
+
* @immutable
|
|
5516
5574
|
*/
|
|
5517
|
-
|
|
5518
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5519
|
-
NOWNIA = "NOWNIA",
|
|
5575
|
+
createdDate?: Date | null;
|
|
5520
5576
|
/**
|
|
5521
|
-
*
|
|
5522
|
-
*
|
|
5577
|
+
* Aggregated refund summary.
|
|
5578
|
+
* @readonly
|
|
5523
5579
|
*/
|
|
5524
|
-
|
|
5525
|
-
/** Codux Headless Sites */
|
|
5526
|
-
CODUX = "CODUX",
|
|
5527
|
-
/** Bobb - AI Design Creator. */
|
|
5528
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
5580
|
+
summary?: AggregatedRefundSummary;
|
|
5529
5581
|
/**
|
|
5530
|
-
*
|
|
5531
|
-
*
|
|
5582
|
+
* ID of the app that initiated this refund.
|
|
5583
|
+
* @format GUID
|
|
5584
|
+
* @readonly
|
|
5585
|
+
* @immutable
|
|
5532
5586
|
*/
|
|
5533
|
-
|
|
5534
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5535
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5536
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5537
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5538
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5539
|
-
MIMIR = "MIMIR",
|
|
5540
|
-
/** Wix Twins platform. */
|
|
5541
|
-
TWINS = "TWINS",
|
|
5542
|
-
/** Wix Nano. */
|
|
5543
|
-
NANO = "NANO",
|
|
5544
|
-
/** Base44 headless sites. */
|
|
5545
|
-
BASE44 = "BASE44",
|
|
5546
|
-
/** Wix Channels Sites */
|
|
5547
|
-
CHANNELS = "CHANNELS",
|
|
5548
|
-
/** Nautilus platform. */
|
|
5549
|
-
NAUTILUS = "NAUTILUS"
|
|
5587
|
+
requestingServiceAppId?: string | null;
|
|
5550
5588
|
}
|
|
5551
|
-
|
|
5552
|
-
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS';
|
|
5553
|
-
/** Site transferred to another user. */
|
|
5554
|
-
interface SiteTransferred {
|
|
5589
|
+
interface RefundTransaction {
|
|
5555
5590
|
/**
|
|
5556
|
-
*
|
|
5591
|
+
* ID of the payment associated with this refund.
|
|
5557
5592
|
* @format GUID
|
|
5593
|
+
* @immutable
|
|
5558
5594
|
*/
|
|
5559
|
-
|
|
5595
|
+
paymentId?: string;
|
|
5560
5596
|
/**
|
|
5561
|
-
*
|
|
5562
|
-
* @
|
|
5597
|
+
* Refund amount.
|
|
5598
|
+
* @immutable
|
|
5563
5599
|
*/
|
|
5564
|
-
|
|
5565
|
-
|
|
5566
|
-
|
|
5567
|
-
|
|
5568
|
-
|
|
5569
|
-
deleteContext?: DeleteContext;
|
|
5570
|
-
}
|
|
5571
|
-
interface DeleteContext {
|
|
5572
|
-
/** When the meta site was deleted. */
|
|
5573
|
-
dateDeleted?: Date | null;
|
|
5574
|
-
/** A status. */
|
|
5575
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
5600
|
+
amount?: Price;
|
|
5601
|
+
/** Refund status. */
|
|
5602
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5603
|
+
/** Optional details of current refund status. */
|
|
5604
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
5576
5605
|
/**
|
|
5577
|
-
*
|
|
5578
|
-
*
|
|
5606
|
+
* Payment gateway's refund ID.
|
|
5607
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
5608
|
+
* @format GUID
|
|
5579
5609
|
*/
|
|
5580
|
-
|
|
5610
|
+
gatewayRefundId?: string | null;
|
|
5611
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5612
|
+
providerRefundId?: string | null;
|
|
5581
5613
|
/**
|
|
5582
|
-
*
|
|
5583
|
-
* @
|
|
5614
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5615
|
+
* @immutable
|
|
5584
5616
|
*/
|
|
5585
|
-
|
|
5617
|
+
externalRefund?: boolean;
|
|
5586
5618
|
}
|
|
5587
|
-
|
|
5588
|
-
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5619
|
+
/** Refund transaction status. */
|
|
5620
|
+
declare enum RefundStatus {
|
|
5621
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5622
|
+
PENDING = "PENDING",
|
|
5623
|
+
/** Refund transaction succeeded. */
|
|
5624
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5625
|
+
/** Refund transaction failed. */
|
|
5626
|
+
FAILED = "FAILED",
|
|
5627
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
5628
|
+
SCHEDULED = "SCHEDULED",
|
|
5629
|
+
/** Refund was initiated on payment provider side. */
|
|
5630
|
+
STARTED = "STARTED"
|
|
5593
5631
|
}
|
|
5594
5632
|
/** @enumType */
|
|
5595
|
-
type
|
|
5596
|
-
|
|
5597
|
-
interface SiteUndeleted {
|
|
5598
|
-
}
|
|
5599
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5600
|
-
interface SitePublished {
|
|
5601
|
-
}
|
|
5602
|
-
interface SiteUnpublished {
|
|
5633
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5634
|
+
interface RefundStatusInfo {
|
|
5603
5635
|
/**
|
|
5604
|
-
*
|
|
5605
|
-
*
|
|
5606
|
-
*
|
|
5636
|
+
* Reason code for the refund's current status.
|
|
5637
|
+
*
|
|
5638
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5639
|
+
* @minLength 1
|
|
5640
|
+
* @maxLength 10
|
|
5607
5641
|
*/
|
|
5608
|
-
|
|
5609
|
-
|
|
5610
|
-
|
|
5642
|
+
paymentGatewayReasonCode?: string | null;
|
|
5643
|
+
/**
|
|
5644
|
+
* Free text explanation of current refund status.
|
|
5645
|
+
* @minLength 1
|
|
5646
|
+
* @maxLength 1000
|
|
5647
|
+
*/
|
|
5648
|
+
description?: string | null;
|
|
5611
5649
|
}
|
|
5612
|
-
interface
|
|
5650
|
+
interface AggregatedRefundSummary {
|
|
5651
|
+
/** Total amount requested for refund. */
|
|
5652
|
+
requestedRefund?: Price;
|
|
5653
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5654
|
+
pendingRefund?: Price;
|
|
5655
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5656
|
+
refunded?: Price;
|
|
5657
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5658
|
+
failedRefundAmount?: Price;
|
|
5659
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5660
|
+
pending?: boolean;
|
|
5661
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5662
|
+
breakdown?: RefundItemsBreakdown;
|
|
5613
5663
|
}
|
|
5614
|
-
|
|
5615
|
-
* Represents a service provisioned a site.
|
|
5616
|
-
*
|
|
5617
|
-
* Note on `origin_instance_id`:
|
|
5618
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5619
|
-
* This is because of the following scenario:
|
|
5620
|
-
*
|
|
5621
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5622
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5623
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
5624
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5625
|
-
* your site remains consistent with what you initially received and does not include any
|
|
5626
|
-
* changes made to the original template afterward.
|
|
5627
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5628
|
-
*/
|
|
5629
|
-
interface ServiceProvisioned {
|
|
5664
|
+
interface RefundItemsBreakdown {
|
|
5630
5665
|
/**
|
|
5631
|
-
*
|
|
5632
|
-
* @
|
|
5666
|
+
* Refunded line items and the amount refunded for each.
|
|
5667
|
+
* @maxSize 300
|
|
5633
5668
|
*/
|
|
5634
|
-
|
|
5669
|
+
lineItems?: LineItemRefundSummary[];
|
|
5670
|
+
}
|
|
5671
|
+
interface LineItemRefundSummary {
|
|
5635
5672
|
/**
|
|
5636
|
-
*
|
|
5637
|
-
* @
|
|
5673
|
+
* ID of the refunded line item.
|
|
5674
|
+
* @format GUID
|
|
5638
5675
|
*/
|
|
5639
|
-
|
|
5676
|
+
lineItemId?: string;
|
|
5677
|
+
/** Total refunded amount for the line item. */
|
|
5678
|
+
totalRefundedAmount?: Price;
|
|
5679
|
+
}
|
|
5680
|
+
interface CalculateRefundRequest {
|
|
5640
5681
|
/**
|
|
5641
|
-
*
|
|
5642
|
-
* @
|
|
5682
|
+
* Order ID
|
|
5683
|
+
* @minLength 1
|
|
5684
|
+
* @maxLength 100
|
|
5643
5685
|
*/
|
|
5644
|
-
|
|
5686
|
+
ecomOrderId?: string;
|
|
5645
5687
|
/**
|
|
5646
|
-
*
|
|
5647
|
-
* @
|
|
5688
|
+
* Refunded line items and quantity
|
|
5689
|
+
* @maxSize 300
|
|
5648
5690
|
*/
|
|
5649
|
-
|
|
5691
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5692
|
+
/** Should include shipping in refund calculation */
|
|
5693
|
+
refundShipping?: boolean;
|
|
5694
|
+
}
|
|
5695
|
+
interface CalculateRefundItemRequest {
|
|
5650
5696
|
/**
|
|
5651
|
-
*
|
|
5697
|
+
* ID of the line item being refunded
|
|
5652
5698
|
* @format GUID
|
|
5653
5699
|
*/
|
|
5654
|
-
|
|
5655
|
-
}
|
|
5656
|
-
interface ServiceRemoved {
|
|
5700
|
+
id?: string;
|
|
5657
5701
|
/**
|
|
5658
|
-
*
|
|
5659
|
-
* @
|
|
5702
|
+
* How much of that line item is being refunded
|
|
5703
|
+
* @min 1
|
|
5704
|
+
* @max 100000
|
|
5660
5705
|
*/
|
|
5661
|
-
|
|
5706
|
+
quantity?: number;
|
|
5707
|
+
}
|
|
5708
|
+
interface CalculateRefundResponse {
|
|
5709
|
+
/** Total refundable amount */
|
|
5710
|
+
total?: Price;
|
|
5711
|
+
/** Tax cost of the order */
|
|
5712
|
+
tax?: Price;
|
|
5713
|
+
/** Discount given for this order */
|
|
5714
|
+
discount?: Price;
|
|
5715
|
+
/** Total cost of the order (without tax) */
|
|
5716
|
+
subtotal?: Price;
|
|
5717
|
+
/** Total shipping cost for order */
|
|
5718
|
+
shipping?: Price;
|
|
5719
|
+
/** Previous refund given on that order */
|
|
5720
|
+
previouslyRefundedAmount?: Price;
|
|
5662
5721
|
/**
|
|
5663
|
-
*
|
|
5664
|
-
* @
|
|
5722
|
+
* The refundable items of that order
|
|
5723
|
+
* @maxSize 300
|
|
5665
5724
|
*/
|
|
5666
|
-
|
|
5725
|
+
items?: CalculateRefundItemResponse[];
|
|
5726
|
+
}
|
|
5727
|
+
interface CalculateRefundItemResponse {
|
|
5667
5728
|
/**
|
|
5668
|
-
*
|
|
5669
|
-
* @
|
|
5729
|
+
* Line item ID
|
|
5730
|
+
* @format GUID
|
|
5670
5731
|
*/
|
|
5671
|
-
|
|
5732
|
+
id?: string;
|
|
5733
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5734
|
+
price?: Price;
|
|
5672
5735
|
}
|
|
5673
|
-
|
|
5674
|
-
interface SiteRenamed {
|
|
5736
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
5675
5737
|
/**
|
|
5676
|
-
*
|
|
5677
|
-
* @
|
|
5738
|
+
* Wix eCommerce order ID
|
|
5739
|
+
* @minLength 1
|
|
5740
|
+
* @maxLength 100
|
|
5678
5741
|
*/
|
|
5679
|
-
|
|
5742
|
+
ecomOrderId: string;
|
|
5680
5743
|
/**
|
|
5681
|
-
*
|
|
5682
|
-
* @
|
|
5744
|
+
* Payment IDs
|
|
5745
|
+
* @minSize 1
|
|
5746
|
+
* @maxSize 100
|
|
5747
|
+
* @format GUID
|
|
5683
5748
|
*/
|
|
5684
|
-
|
|
5685
|
-
}
|
|
5686
|
-
/**
|
|
5687
|
-
* Hard deletion of the meta site.
|
|
5688
|
-
*
|
|
5689
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5690
|
-
*/
|
|
5691
|
-
interface SiteHardDeleted {
|
|
5692
|
-
/** A deletion context. */
|
|
5693
|
-
deleteContext?: DeleteContext;
|
|
5694
|
-
}
|
|
5695
|
-
interface NamespaceChanged {
|
|
5696
|
-
/** A previous namespace. */
|
|
5697
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
5698
|
-
/** A new namespace. */
|
|
5699
|
-
newNamespace?: NamespaceWithLiterals;
|
|
5700
|
-
}
|
|
5701
|
-
/** Assigned Studio editor */
|
|
5702
|
-
interface StudioAssigned {
|
|
5703
|
-
}
|
|
5704
|
-
/** Unassigned Studio editor */
|
|
5705
|
-
interface StudioUnassigned {
|
|
5749
|
+
paymentIds: string[];
|
|
5706
5750
|
}
|
|
5707
|
-
|
|
5708
|
-
|
|
5709
|
-
|
|
5710
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5711
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5712
|
-
*
|
|
5713
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
5714
|
-
*/
|
|
5715
|
-
interface SiteUrlChanged {
|
|
5751
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
5752
|
+
/** All order's transactions after the void was triggered */
|
|
5753
|
+
orderTransactions?: OrderTransactions;
|
|
5716
5754
|
}
|
|
5717
|
-
|
|
5718
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5719
|
-
* Consumed by other teams to remove relevant data.
|
|
5720
|
-
*/
|
|
5721
|
-
interface SitePurgedExternally {
|
|
5755
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
5722
5756
|
/**
|
|
5723
|
-
*
|
|
5757
|
+
* Wix eCommerce order ID
|
|
5758
|
+
* @minLength 1
|
|
5759
|
+
* @maxLength 100
|
|
5760
|
+
*/
|
|
5761
|
+
ecomOrderId: string;
|
|
5762
|
+
/**
|
|
5763
|
+
* Capture payments information
|
|
5764
|
+
* @minSize 1
|
|
5724
5765
|
* @maxSize 100
|
|
5725
|
-
* @deprecated
|
|
5726
|
-
* @targetRemovalDate 2025-04-15
|
|
5727
5766
|
*/
|
|
5728
|
-
|
|
5729
|
-
}
|
|
5730
|
-
/** Assigned Odeditor */
|
|
5731
|
-
interface OdeditorAssigned {
|
|
5732
|
-
}
|
|
5733
|
-
/** Unassigned Odeditor */
|
|
5734
|
-
interface OdeditorUnassigned {
|
|
5735
|
-
}
|
|
5736
|
-
/** Assigned Picasso editor */
|
|
5737
|
-
interface PicassoAssigned {
|
|
5738
|
-
}
|
|
5739
|
-
/** Unassigned Picasso */
|
|
5740
|
-
interface PicassoUnassigned {
|
|
5741
|
-
}
|
|
5742
|
-
/** Assigned Wixel */
|
|
5743
|
-
interface WixelAssigned {
|
|
5744
|
-
}
|
|
5745
|
-
/** Unassigned Wixel */
|
|
5746
|
-
interface WixelUnassigned {
|
|
5747
|
-
}
|
|
5748
|
-
/** Assigned StudioTwo */
|
|
5749
|
-
interface StudioTwoAssigned {
|
|
5750
|
-
}
|
|
5751
|
-
/** Unassigned StudioTwo */
|
|
5752
|
-
interface StudioTwoUnassigned {
|
|
5753
|
-
}
|
|
5754
|
-
/** Media from user domain is enabled. */
|
|
5755
|
-
interface UserDomainMediaEnabled {
|
|
5756
|
-
}
|
|
5757
|
-
/** Media from user domain is disabled. */
|
|
5758
|
-
interface UserDomainMediaDisabled {
|
|
5759
|
-
}
|
|
5760
|
-
/** Assigned Editorless */
|
|
5761
|
-
interface EditorlessAssigned {
|
|
5762
|
-
}
|
|
5763
|
-
/** Unassigned Editorless */
|
|
5764
|
-
interface EditorlessUnassigned {
|
|
5765
|
-
}
|
|
5766
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
5767
|
-
}
|
|
5768
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
5769
|
-
hasCustomConfigurations?: boolean;
|
|
5770
|
-
}
|
|
5771
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
5772
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
5773
|
-
sendCustomEmailConfigs?: boolean;
|
|
5774
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5775
|
-
origin?: OriginWithLiterals;
|
|
5767
|
+
payments: PaymentCapture[];
|
|
5776
5768
|
}
|
|
5777
|
-
|
|
5778
|
-
|
|
5779
|
-
|
|
5769
|
+
interface PaymentCapture {
|
|
5770
|
+
/**
|
|
5771
|
+
* Payment ID
|
|
5772
|
+
* @format GUID
|
|
5773
|
+
*/
|
|
5774
|
+
paymentId?: string | null;
|
|
5775
|
+
/**
|
|
5776
|
+
* Capture amount.
|
|
5777
|
+
* If not provided - full authorized amount will be captured.
|
|
5778
|
+
*/
|
|
5779
|
+
amount?: Price;
|
|
5780
5780
|
}
|
|
5781
|
-
|
|
5782
|
-
|
|
5783
|
-
|
|
5784
|
-
success?: boolean;
|
|
5781
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
5782
|
+
/** All order's transactions after the capture was triggered */
|
|
5783
|
+
orderTransactions?: OrderTransactions;
|
|
5785
5784
|
}
|
|
5786
|
-
interface
|
|
5785
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
5786
|
+
/**
|
|
5787
|
+
* Ecom Order ID.
|
|
5788
|
+
* @minLength 1
|
|
5789
|
+
* @maxLength 100
|
|
5790
|
+
*/
|
|
5791
|
+
ecomOrderId?: string;
|
|
5792
|
+
/** Amount to be charged */
|
|
5793
|
+
amount?: Price;
|
|
5787
5794
|
}
|
|
5788
|
-
interface
|
|
5789
|
-
|
|
5795
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
5796
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
5797
|
+
paymentGatewayOrderId?: string;
|
|
5790
5798
|
}
|
|
5791
5799
|
interface DiffmatokyPayload {
|
|
5792
5800
|
left?: string;
|
|
@@ -7771,4 +7779,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
|
|
|
7771
7779
|
declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
|
|
7772
7780
|
declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
|
|
7773
7781
|
|
|
7774
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|
|
7782
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|