@wix/auto_sdk_ecom_orders 1.0.245 → 1.0.247
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/{ecom-v1-order-orders.universal-KcLEcCNU.d.ts → ecom-v1-order-orders.universal-DCa6i0d-.d.ts} +1570 -1570
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +75 -75
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +75 -75
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1570 -1570
- package/build/cjs/meta.js +75 -75
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-KcLEcCNU.d.mts → ecom-v1-order-orders.universal-DCa6i0d-.d.mts} +1570 -1570
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +75 -75
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +75 -75
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1570 -1570
- package/build/es/meta.mjs +75 -75
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-HbPNk6ZU.d.ts → ecom-v1-order-orders.universal-CiTSaXQ4.d.ts} +1678 -1650
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js +75 -75
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +75 -75
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1570 -1570
- package/build/internal/cjs/meta.js +75 -75
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/{ecom-v1-order-orders.universal-HbPNk6ZU.d.mts → ecom-v1-order-orders.universal-CiTSaXQ4.d.mts} +1678 -1650
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs +75 -75
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +75 -75
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1570 -1570
- package/build/internal/es/meta.mjs +75 -75
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -3738,450 +3738,163 @@ interface TriggerReindexOrderRequest {
|
|
|
3738
3738
|
*/
|
|
3739
3739
|
orderId?: string;
|
|
3740
3740
|
}
|
|
3741
|
-
interface
|
|
3741
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
3742
|
+
/** @format GUID */
|
|
3743
|
+
orderId?: string;
|
|
3744
|
+
}
|
|
3745
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
3746
|
+
}
|
|
3747
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
3742
3748
|
/**
|
|
3743
|
-
* Ecom order ID.
|
|
3744
3749
|
* @minLength 1
|
|
3745
3750
|
* @maxLength 100
|
|
3746
3751
|
*/
|
|
3747
|
-
|
|
3748
|
-
/** Amount to collect */
|
|
3749
|
-
amount: Price;
|
|
3750
|
-
/**
|
|
3751
|
-
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
3752
|
-
* Existing payment gateway order will be updated with a new amount.
|
|
3753
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
3754
|
-
*/
|
|
3755
|
-
paymentGatewayOrderId?: string | null;
|
|
3756
|
-
/**
|
|
3757
|
-
* Whether to delay capture of the payment.
|
|
3758
|
-
* Default: false
|
|
3759
|
-
* @deprecated Whether to delay capture of the payment.
|
|
3760
|
-
* Default: false
|
|
3761
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
3762
|
-
* @targetRemovalDate 2024-09-30
|
|
3763
|
-
*/
|
|
3764
|
-
delayedCapture?: boolean;
|
|
3765
|
-
/** Delayed capture payment settings */
|
|
3766
|
-
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
3752
|
+
orderId?: string;
|
|
3767
3753
|
}
|
|
3768
|
-
interface
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
* @format WEB_URL
|
|
3772
|
-
*/
|
|
3773
|
-
successUrl?: string | null;
|
|
3774
|
-
/**
|
|
3775
|
-
* URL to redirect buyer in case of buyer canceled the transaction
|
|
3776
|
-
* @format WEB_URL
|
|
3777
|
-
*/
|
|
3778
|
-
cancelUrl?: string | null;
|
|
3779
|
-
/**
|
|
3780
|
-
* URL to redirect buyer in case of failed/rejected transaction
|
|
3781
|
-
* @format WEB_URL
|
|
3782
|
-
*/
|
|
3783
|
-
errorUrl?: string | null;
|
|
3754
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
3755
|
+
}
|
|
3756
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
3784
3757
|
/**
|
|
3785
|
-
*
|
|
3786
|
-
* @
|
|
3758
|
+
* @minLength 1
|
|
3759
|
+
* @maxLength 100
|
|
3787
3760
|
*/
|
|
3788
|
-
|
|
3789
|
-
}
|
|
3790
|
-
interface DelayedCaptureSettings {
|
|
3791
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
3792
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
3793
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
3794
|
-
delayDuration?: Duration;
|
|
3761
|
+
orderId?: string;
|
|
3795
3762
|
}
|
|
3796
|
-
|
|
3797
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
3798
|
-
VOID = "VOID",
|
|
3799
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
3800
|
-
CAPTURE = "CAPTURE"
|
|
3763
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
3801
3764
|
}
|
|
3802
|
-
|
|
3803
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
3804
|
-
interface Duration {
|
|
3765
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
3805
3766
|
/**
|
|
3806
|
-
*
|
|
3807
|
-
* @
|
|
3767
|
+
* IDs of orders to send pickup emails for.
|
|
3768
|
+
* @minSize 1
|
|
3769
|
+
* @maxSize 300
|
|
3808
3770
|
*/
|
|
3809
|
-
|
|
3810
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
3811
|
-
unit?: DurationUnitWithLiterals;
|
|
3812
|
-
}
|
|
3813
|
-
declare enum DurationUnit {
|
|
3814
|
-
MINUTES = "MINUTES",
|
|
3815
|
-
HOURS = "HOURS",
|
|
3816
|
-
DAYS = "DAYS"
|
|
3771
|
+
orderIds?: string[];
|
|
3817
3772
|
}
|
|
3818
|
-
|
|
3819
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
3820
|
-
interface PreparePaymentCollectionResponse {
|
|
3821
|
-
/** Payment gateway order id which is associated with given payment */
|
|
3822
|
-
paymentGatewayOrderId?: string;
|
|
3773
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
3823
3774
|
}
|
|
3824
|
-
interface
|
|
3775
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
3825
3776
|
/**
|
|
3826
|
-
* Ecom order ID.
|
|
3827
3777
|
* @minLength 1
|
|
3828
3778
|
* @maxLength 100
|
|
3829
3779
|
*/
|
|
3830
|
-
|
|
3831
|
-
}
|
|
3832
|
-
interface GetPaymentCollectabilityStatusResponse {
|
|
3833
|
-
/** Payment collectability status */
|
|
3834
|
-
status?: PaymentCollectabilityStatusWithLiterals;
|
|
3835
|
-
/** Collectable order amount */
|
|
3836
|
-
amount?: Price;
|
|
3780
|
+
orderId?: string;
|
|
3837
3781
|
}
|
|
3838
|
-
|
|
3839
|
-
UNKNOWN = "UNKNOWN",
|
|
3840
|
-
COLLECTABLE = "COLLECTABLE",
|
|
3841
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
3842
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
3843
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
3844
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
3845
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
3846
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
3847
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
3848
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
3849
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
3850
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
3782
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
3851
3783
|
}
|
|
3852
|
-
|
|
3853
|
-
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';
|
|
3854
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
3784
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
3855
3785
|
/**
|
|
3856
|
-
*
|
|
3857
|
-
* @
|
|
3858
|
-
* @
|
|
3786
|
+
* IDs of orders to send pickup emails for.
|
|
3787
|
+
* @minSize 1
|
|
3788
|
+
* @maxSize 300
|
|
3859
3789
|
*/
|
|
3860
|
-
|
|
3861
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
3862
|
-
amount: Price;
|
|
3790
|
+
orderIds?: string[];
|
|
3863
3791
|
}
|
|
3864
|
-
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
*/
|
|
3868
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
3869
|
-
/** Predefined payment method. */
|
|
3870
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
3792
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
3793
|
+
}
|
|
3794
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
3871
3795
|
/**
|
|
3872
|
-
* Custom payment method name provided by user.
|
|
3873
|
-
*
|
|
3874
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
3875
3796
|
* @minLength 1
|
|
3876
3797
|
* @maxLength 100
|
|
3877
3798
|
*/
|
|
3878
|
-
|
|
3799
|
+
orderId?: string;
|
|
3879
3800
|
}
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
3801
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
3802
|
+
}
|
|
3803
|
+
interface SendCancelRefundEmailRequest {
|
|
3884
3804
|
/**
|
|
3885
|
-
*
|
|
3886
|
-
*
|
|
3887
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
3805
|
+
* The ID of order that is canceled/refunded
|
|
3888
3806
|
* @minLength 1
|
|
3889
3807
|
* @maxLength 100
|
|
3890
3808
|
*/
|
|
3891
|
-
|
|
3892
|
-
}
|
|
3893
|
-
/** Predefined payment method types for offline/manual payments. */
|
|
3894
|
-
declare enum PredefinedPaymentMethod {
|
|
3895
|
-
/** Cash payment. */
|
|
3896
|
-
CASH = "CASH",
|
|
3897
|
-
/** Bank transfer. */
|
|
3898
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
3899
|
-
/** Payment by check. */
|
|
3900
|
-
CHECK = "CHECK"
|
|
3901
|
-
}
|
|
3902
|
-
/** @enumType */
|
|
3903
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
3904
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
3905
|
-
}
|
|
3906
|
-
interface MarkOrderAsPaidRequest {
|
|
3809
|
+
orderId?: string;
|
|
3907
3810
|
/**
|
|
3908
|
-
*
|
|
3811
|
+
* Personal note added to the email (optional)
|
|
3909
3812
|
* @minLength 1
|
|
3910
|
-
* @maxLength
|
|
3813
|
+
* @maxLength 1000
|
|
3911
3814
|
*/
|
|
3912
|
-
|
|
3815
|
+
customMessage?: string | null;
|
|
3816
|
+
/** Refund amount */
|
|
3817
|
+
refundAmount?: Price;
|
|
3818
|
+
/**
|
|
3819
|
+
* Refund ID. (Optional)
|
|
3820
|
+
* @format GUID
|
|
3821
|
+
*/
|
|
3822
|
+
refundId?: string | null;
|
|
3913
3823
|
}
|
|
3914
|
-
interface
|
|
3915
|
-
/** Updated order. */
|
|
3916
|
-
order?: Order;
|
|
3824
|
+
interface SendCancelRefundEmailResponse {
|
|
3917
3825
|
}
|
|
3918
|
-
interface
|
|
3826
|
+
interface SendRefundEmailRequest {
|
|
3919
3827
|
/**
|
|
3920
|
-
*
|
|
3921
|
-
* @
|
|
3922
|
-
* @maxSize 100
|
|
3923
|
-
* @minLength 1
|
|
3924
|
-
* @maxLength 100
|
|
3828
|
+
* The ID of order that is refunded
|
|
3829
|
+
* @format GUID
|
|
3925
3830
|
*/
|
|
3926
|
-
|
|
3927
|
-
}
|
|
3928
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
3831
|
+
orderId?: string;
|
|
3929
3832
|
/**
|
|
3930
|
-
*
|
|
3931
|
-
*
|
|
3833
|
+
* Refund ID
|
|
3834
|
+
* @format GUID
|
|
3932
3835
|
*/
|
|
3933
|
-
|
|
3934
|
-
/** Bulk action metadata. */
|
|
3935
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
3936
|
-
}
|
|
3937
|
-
interface BulkOrderResult {
|
|
3938
|
-
/** Item metadata. */
|
|
3939
|
-
itemMetadata?: ItemMetadata;
|
|
3836
|
+
refundId?: string;
|
|
3940
3837
|
/**
|
|
3941
|
-
*
|
|
3942
|
-
*
|
|
3943
|
-
*
|
|
3838
|
+
* Personal note added to the email (optional)
|
|
3839
|
+
* @minLength 1
|
|
3840
|
+
* @maxLength 1000
|
|
3944
3841
|
*/
|
|
3945
|
-
|
|
3842
|
+
customMessage?: string | null;
|
|
3946
3843
|
}
|
|
3947
|
-
interface
|
|
3948
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
3949
|
-
_id?: string | null;
|
|
3950
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
3951
|
-
originalIndex?: number;
|
|
3952
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
3953
|
-
success?: boolean;
|
|
3954
|
-
/** Details about the error in case of failure. */
|
|
3955
|
-
error?: ApplicationError;
|
|
3844
|
+
interface SendRefundEmailResponse {
|
|
3956
3845
|
}
|
|
3957
|
-
interface
|
|
3958
|
-
/**
|
|
3959
|
-
|
|
3960
|
-
/**
|
|
3961
|
-
|
|
3962
|
-
/** Data related to the error. */
|
|
3963
|
-
data?: Record<string, any> | null;
|
|
3846
|
+
interface SendFulfillmentEmailRequest {
|
|
3847
|
+
/** @format GUID */
|
|
3848
|
+
orderId?: string;
|
|
3849
|
+
/** @format GUID */
|
|
3850
|
+
fulfillerId?: string;
|
|
3964
3851
|
}
|
|
3965
|
-
interface
|
|
3966
|
-
/** Number of items that were successfully processed. */
|
|
3967
|
-
totalSuccesses?: number;
|
|
3968
|
-
/** Number of items that couldn't be processed. */
|
|
3969
|
-
totalFailures?: number;
|
|
3970
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
3971
|
-
undetailedFailures?: number;
|
|
3852
|
+
interface SendFulfillmentEmailResponse {
|
|
3972
3853
|
}
|
|
3973
|
-
interface
|
|
3854
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
3974
3855
|
/**
|
|
3975
|
-
* Order ID.
|
|
3976
3856
|
* @minLength 1
|
|
3977
3857
|
* @maxLength 100
|
|
3978
3858
|
*/
|
|
3979
|
-
|
|
3980
|
-
}
|
|
3981
|
-
interface GetRefundabilityStatusResponse {
|
|
3982
|
-
/**
|
|
3983
|
-
* Refundability details.
|
|
3984
|
-
* @maxSize 300
|
|
3985
|
-
*/
|
|
3986
|
-
refundabilities?: Refundability[];
|
|
3987
|
-
/**
|
|
3988
|
-
* Whether the order supports refunding per item.
|
|
3989
|
-
* @deprecated
|
|
3990
|
-
*/
|
|
3991
|
-
refundablePerItem?: boolean;
|
|
3992
|
-
}
|
|
3993
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
3994
|
-
/** Reason why payment is not refundable. */
|
|
3995
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
3996
|
-
/** Reason why payment is only refundable manually. */
|
|
3997
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
3998
|
-
/** Payment ID. */
|
|
3999
|
-
paymentId?: string;
|
|
4000
|
-
/** Payment refundability status. */
|
|
4001
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4002
|
-
/** Link to payment provider dashboard. */
|
|
4003
|
-
providerLink?: string | null;
|
|
4004
|
-
}
|
|
4005
|
-
/** @oneof */
|
|
4006
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4007
|
-
/** Reason why payment is not refundable. */
|
|
4008
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4009
|
-
/** Reason why payment is only refundable manually. */
|
|
4010
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
3859
|
+
orderId?: string;
|
|
4011
3860
|
}
|
|
4012
|
-
|
|
4013
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4014
|
-
MANUAL = "MANUAL",
|
|
4015
|
-
REFUNDABLE = "REFUNDABLE"
|
|
3861
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
4016
3862
|
}
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
declare enum NonRefundableReason {
|
|
4020
|
-
NONE = "NONE",
|
|
4021
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4022
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4023
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4024
|
-
NOT_PAID = "NOT_PAID",
|
|
4025
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4026
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
4027
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4028
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
4029
|
-
FORBIDDEN = "FORBIDDEN",
|
|
4030
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4031
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4032
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
3863
|
+
interface PreviewEmailByTypeRequest {
|
|
3864
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
4033
3865
|
}
|
|
4034
|
-
|
|
4035
|
-
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
|
|
4039
|
-
OFFLINE = "OFFLINE",
|
|
4040
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
3866
|
+
declare enum PreviewEmailType {
|
|
3867
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
3868
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
3869
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
3870
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4041
3871
|
}
|
|
4042
3872
|
/** @enumType */
|
|
4043
|
-
type
|
|
4044
|
-
interface
|
|
4045
|
-
|
|
4046
|
-
* Ecom order ID.
|
|
4047
|
-
* @minLength 1
|
|
4048
|
-
* @maxLength 100
|
|
4049
|
-
*/
|
|
4050
|
-
ecomOrderId: string;
|
|
4051
|
-
/** Information about the user who initiated the payment. */
|
|
4052
|
-
chargedBy?: ChargedBy;
|
|
4053
|
-
}
|
|
4054
|
-
interface ChargedBy {
|
|
4055
|
-
/**
|
|
4056
|
-
* ID - id of the user who initiated the payment
|
|
4057
|
-
* @format GUID
|
|
4058
|
-
*/
|
|
4059
|
-
_id?: string;
|
|
4060
|
-
/**
|
|
4061
|
-
* Full name - name of the user who initiated the payment
|
|
4062
|
-
* @minLength 1
|
|
4063
|
-
* @maxLength 200
|
|
4064
|
-
*/
|
|
4065
|
-
fullName?: string | null;
|
|
4066
|
-
}
|
|
4067
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
4068
|
-
/** ID of the order created in the payment gateway */
|
|
4069
|
-
paymentGatewayOrderId?: string;
|
|
4070
|
-
}
|
|
4071
|
-
interface ChargeMembershipsRequest {
|
|
4072
|
-
/**
|
|
4073
|
-
* Order ID.
|
|
4074
|
-
* @minLength 1
|
|
4075
|
-
* @maxLength 100
|
|
4076
|
-
*/
|
|
4077
|
-
ecomOrderId: string;
|
|
4078
|
-
/**
|
|
4079
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4080
|
-
* but a user which is using the membership on behalf of the a member
|
|
4081
|
-
* @format GUID
|
|
4082
|
-
*/
|
|
4083
|
-
memberId: string;
|
|
4084
|
-
/**
|
|
4085
|
-
* List of items to be paid by memberships
|
|
4086
|
-
* @minSize 1
|
|
4087
|
-
* @maxSize 300
|
|
4088
|
-
*/
|
|
4089
|
-
membershipCharges?: MembershipChargeItem[];
|
|
3873
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
3874
|
+
interface PreviewEmailByTypeResponse {
|
|
3875
|
+
emailPreview?: string;
|
|
4090
3876
|
}
|
|
4091
|
-
interface
|
|
4092
|
-
/**
|
|
4093
|
-
* The id of used membership
|
|
4094
|
-
* @minLength 1
|
|
4095
|
-
* @maxLength 100
|
|
4096
|
-
*/
|
|
4097
|
-
membershipId?: string;
|
|
4098
|
-
/**
|
|
4099
|
-
* ID of the application providing this payment option
|
|
4100
|
-
* @format GUID
|
|
4101
|
-
*/
|
|
4102
|
-
appId?: string;
|
|
4103
|
-
/** The name of used membership */
|
|
4104
|
-
membershipName?: MembershipName;
|
|
4105
|
-
/** Additional data about this membership */
|
|
4106
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
4107
|
-
/** Catalog and item reference info. */
|
|
4108
|
-
catalogReference?: CatalogReference;
|
|
4109
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4110
|
-
serviceProperties?: ServiceProperties;
|
|
4111
|
-
/**
|
|
4112
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
4113
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4114
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4115
|
-
* @minLength 1
|
|
4116
|
-
* @maxLength 36
|
|
4117
|
-
*/
|
|
4118
|
-
rootCatalogItemId?: string | null;
|
|
3877
|
+
interface PreviewRefundEmailRequest {
|
|
4119
3878
|
/**
|
|
4120
|
-
* line item id of Checkout/Order line item
|
|
4121
3879
|
* @minLength 1
|
|
4122
3880
|
* @maxLength 100
|
|
4123
3881
|
*/
|
|
4124
|
-
|
|
4125
|
-
|
|
4126
|
-
|
|
4127
|
-
/**
|
|
4128
|
-
|
|
4129
|
-
* @maxLength 100
|
|
4130
|
-
*/
|
|
4131
|
-
original?: string;
|
|
4132
|
-
/**
|
|
4133
|
-
* Translated membership name. Defaults to `original` when not provided.
|
|
4134
|
-
* @maxLength 100
|
|
4135
|
-
*/
|
|
4136
|
-
translated?: string | null;
|
|
4137
|
-
}
|
|
4138
|
-
interface ServiceProperties {
|
|
4139
|
-
/**
|
|
4140
|
-
* 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.
|
|
4141
|
-
* For example, the start time of a class.
|
|
4142
|
-
*/
|
|
4143
|
-
scheduledDate?: Date | null;
|
|
4144
|
-
/**
|
|
4145
|
-
* 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.
|
|
4146
|
-
* @min 1
|
|
4147
|
-
* @max 10000
|
|
4148
|
-
*/
|
|
4149
|
-
numberOfParticipants?: number | null;
|
|
4150
|
-
}
|
|
4151
|
-
interface ChargeMembershipsResponse {
|
|
4152
|
-
}
|
|
4153
|
-
interface TriggerRefundRequest {
|
|
3882
|
+
orderId?: string;
|
|
3883
|
+
/** Refund amount */
|
|
3884
|
+
refundAmount?: Price;
|
|
3885
|
+
/** Refund business details */
|
|
3886
|
+
details?: RefundDetails;
|
|
4154
3887
|
/**
|
|
4155
|
-
*
|
|
3888
|
+
* Personal note added to the email (optional)
|
|
4156
3889
|
* @minLength 1
|
|
4157
|
-
* @maxLength
|
|
4158
|
-
*/
|
|
4159
|
-
ecomOrderId: string;
|
|
4160
|
-
/**
|
|
4161
|
-
* Refund operations information
|
|
4162
|
-
* @minSize 1
|
|
4163
|
-
* @maxSize 1
|
|
3890
|
+
* @maxLength 1000
|
|
4164
3891
|
*/
|
|
4165
|
-
|
|
4166
|
-
/** Business model of a refund */
|
|
4167
|
-
details?: RefundDetails;
|
|
4168
|
-
/** Side effect details related to refund */
|
|
4169
|
-
sideEffects?: RefundSideEffects;
|
|
4170
|
-
}
|
|
4171
|
-
interface PaymentRefund {
|
|
3892
|
+
customMessage?: string | null;
|
|
4172
3893
|
/**
|
|
4173
|
-
*
|
|
3894
|
+
* Refund ID. (Optional)
|
|
4174
3895
|
* @format GUID
|
|
4175
3896
|
*/
|
|
4176
|
-
|
|
4177
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
4178
|
-
amount?: Price;
|
|
4179
|
-
/**
|
|
4180
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
4181
|
-
* 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.
|
|
4182
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
4183
|
-
*/
|
|
4184
|
-
externalRefund?: boolean;
|
|
3897
|
+
refundId?: string | null;
|
|
4185
3898
|
}
|
|
4186
3899
|
/** Business model of a refund request */
|
|
4187
3900
|
interface RefundDetails {
|
|
@@ -4258,1490 +3971,1777 @@ interface ShippingRefund {
|
|
|
4258
3971
|
*/
|
|
4259
3972
|
amount?: Price;
|
|
4260
3973
|
}
|
|
4261
|
-
interface
|
|
4262
|
-
|
|
4263
|
-
|
|
4264
|
-
|
|
4265
|
-
sendOrderRefundedEmail?: boolean;
|
|
3974
|
+
interface PreviewRefundEmailResponse {
|
|
3975
|
+
emailPreview?: string;
|
|
3976
|
+
}
|
|
3977
|
+
interface PreviewCancelEmailRequest {
|
|
4266
3978
|
/**
|
|
4267
|
-
* Custom message added to the refund confirmation email.
|
|
4268
3979
|
* @minLength 1
|
|
4269
|
-
* @maxLength
|
|
3980
|
+
* @maxLength 100
|
|
4270
3981
|
*/
|
|
4271
|
-
|
|
4272
|
-
}
|
|
4273
|
-
interface RestockInfo {
|
|
4274
|
-
/** Restock type. */
|
|
4275
|
-
type?: RestockTypeWithLiterals;
|
|
3982
|
+
orderId?: string;
|
|
4276
3983
|
/**
|
|
4277
|
-
*
|
|
4278
|
-
* @
|
|
3984
|
+
* Personal note added to the email (optional)
|
|
3985
|
+
* @minLength 1
|
|
3986
|
+
* @maxLength 1000
|
|
4279
3987
|
*/
|
|
4280
|
-
|
|
3988
|
+
customMessage?: string | null;
|
|
4281
3989
|
}
|
|
4282
|
-
|
|
4283
|
-
|
|
4284
|
-
ALL_ITEMS = "ALL_ITEMS",
|
|
4285
|
-
SOME_ITEMS = "SOME_ITEMS"
|
|
3990
|
+
interface PreviewCancelEmailResponse {
|
|
3991
|
+
emailPreview?: string;
|
|
4286
3992
|
}
|
|
4287
|
-
|
|
4288
|
-
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
4289
|
-
interface RestockItem {
|
|
3993
|
+
interface PreviewCancelRefundEmailRequest {
|
|
4290
3994
|
/**
|
|
4291
|
-
*
|
|
4292
|
-
* @
|
|
3995
|
+
* @minLength 1
|
|
3996
|
+
* @maxLength 100
|
|
4293
3997
|
*/
|
|
4294
|
-
|
|
3998
|
+
orderId?: string;
|
|
4295
3999
|
/**
|
|
4296
|
-
*
|
|
4297
|
-
* @
|
|
4298
|
-
* @
|
|
4000
|
+
* Personal note added to the email (optional)
|
|
4001
|
+
* @minLength 1
|
|
4002
|
+
* @maxLength 1000
|
|
4003
|
+
*/
|
|
4004
|
+
customMessage?: string | null;
|
|
4005
|
+
/** Refund amount */
|
|
4006
|
+
refundAmount?: Price;
|
|
4007
|
+
/**
|
|
4008
|
+
* Refund ID. (Optional)
|
|
4009
|
+
* @format GUID
|
|
4010
|
+
*/
|
|
4011
|
+
refundId?: string | null;
|
|
4012
|
+
}
|
|
4013
|
+
interface PreviewCancelRefundEmailResponse {
|
|
4014
|
+
emailPreview?: string;
|
|
4015
|
+
}
|
|
4016
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
4017
|
+
}
|
|
4018
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
4019
|
+
emailPreview?: string;
|
|
4020
|
+
}
|
|
4021
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
4022
|
+
}
|
|
4023
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
4024
|
+
emailPreview?: string;
|
|
4025
|
+
}
|
|
4026
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
4027
|
+
}
|
|
4028
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
4029
|
+
emailPreview?: string;
|
|
4030
|
+
}
|
|
4031
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
4032
|
+
}
|
|
4033
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
4034
|
+
emailPreview?: string;
|
|
4035
|
+
}
|
|
4036
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
4037
|
+
}
|
|
4038
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
4039
|
+
emailPreview?: string;
|
|
4040
|
+
}
|
|
4041
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
4042
|
+
/** Emitted on a meta site creation. */
|
|
4043
|
+
siteCreated?: SiteCreated;
|
|
4044
|
+
/** Emitted on a meta site transfer completion. */
|
|
4045
|
+
siteTransferred?: SiteTransferred;
|
|
4046
|
+
/** Emitted on a meta site deletion. */
|
|
4047
|
+
siteDeleted?: SiteDeleted;
|
|
4048
|
+
/** Emitted on a meta site restoration. */
|
|
4049
|
+
siteUndeleted?: SiteUndeleted;
|
|
4050
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4051
|
+
sitePublished?: SitePublished;
|
|
4052
|
+
/** Emitted on a meta site unpublish. */
|
|
4053
|
+
siteUnpublished?: SiteUnpublished;
|
|
4054
|
+
/** Emitted when meta site is marked as template. */
|
|
4055
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4056
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4057
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4058
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4059
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4060
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4061
|
+
serviceRemoved?: ServiceRemoved;
|
|
4062
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4063
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4064
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4065
|
+
hardDeleted?: SiteHardDeleted;
|
|
4066
|
+
/** Emitted on a namespace change. */
|
|
4067
|
+
namespaceChanged?: NamespaceChanged;
|
|
4068
|
+
/** Emitted when Studio is attached. */
|
|
4069
|
+
studioAssigned?: StudioAssigned;
|
|
4070
|
+
/** Emitted when Studio is detached. */
|
|
4071
|
+
studioUnassigned?: StudioUnassigned;
|
|
4072
|
+
/**
|
|
4073
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4074
|
+
* the actual URL.
|
|
4075
|
+
*
|
|
4076
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4077
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4078
|
+
*/
|
|
4079
|
+
urlChanged?: SiteUrlChanged;
|
|
4080
|
+
/** Site is marked as PurgedExternally */
|
|
4081
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4082
|
+
/** Emitted when Odeditor is attached. */
|
|
4083
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4084
|
+
/** Emitted when Odeditor is detached. */
|
|
4085
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4086
|
+
/** Emitted when Picasso is attached. */
|
|
4087
|
+
picassoAssigned?: PicassoAssigned;
|
|
4088
|
+
/** Emitted when Picasso is detached. */
|
|
4089
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4090
|
+
/** Emitted when Wixel is attached. */
|
|
4091
|
+
wixelAssigned?: WixelAssigned;
|
|
4092
|
+
/** Emitted when Wixel is detached. */
|
|
4093
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4094
|
+
/** Emitted when StudioTwo is attached. */
|
|
4095
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4096
|
+
/** Emitted when StudioTwo is detached. */
|
|
4097
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4098
|
+
/** Emitted when media from user domain is enabled. */
|
|
4099
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4100
|
+
/** Emitted when media from user domain is disabled. */
|
|
4101
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4102
|
+
/** Emitted when Editorless is attached. */
|
|
4103
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4104
|
+
/** Emitted when Editorless is detached. */
|
|
4105
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4106
|
+
/**
|
|
4107
|
+
* A meta site id.
|
|
4108
|
+
* @format GUID
|
|
4109
|
+
*/
|
|
4110
|
+
metaSiteId?: string;
|
|
4111
|
+
/** A meta site version. Monotonically increasing. */
|
|
4112
|
+
version?: string;
|
|
4113
|
+
/** A timestamp of the event. */
|
|
4114
|
+
timestamp?: string;
|
|
4115
|
+
/**
|
|
4116
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
4117
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
4118
|
+
* @maxSize 4000
|
|
4119
|
+
*/
|
|
4120
|
+
assets?: Asset[];
|
|
4121
|
+
}
|
|
4122
|
+
/** @oneof */
|
|
4123
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
4124
|
+
/** Emitted on a meta site creation. */
|
|
4125
|
+
siteCreated?: SiteCreated;
|
|
4126
|
+
/** Emitted on a meta site transfer completion. */
|
|
4127
|
+
siteTransferred?: SiteTransferred;
|
|
4128
|
+
/** Emitted on a meta site deletion. */
|
|
4129
|
+
siteDeleted?: SiteDeleted;
|
|
4130
|
+
/** Emitted on a meta site restoration. */
|
|
4131
|
+
siteUndeleted?: SiteUndeleted;
|
|
4132
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
4133
|
+
sitePublished?: SitePublished;
|
|
4134
|
+
/** Emitted on a meta site unpublish. */
|
|
4135
|
+
siteUnpublished?: SiteUnpublished;
|
|
4136
|
+
/** Emitted when meta site is marked as template. */
|
|
4137
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
4138
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
4139
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
4140
|
+
/** Emitted when an application is provisioned (installed). */
|
|
4141
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
4142
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
4143
|
+
serviceRemoved?: ServiceRemoved;
|
|
4144
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
4145
|
+
siteRenamedPayload?: SiteRenamed;
|
|
4146
|
+
/** Emitted when meta site was permanently deleted. */
|
|
4147
|
+
hardDeleted?: SiteHardDeleted;
|
|
4148
|
+
/** Emitted on a namespace change. */
|
|
4149
|
+
namespaceChanged?: NamespaceChanged;
|
|
4150
|
+
/** Emitted when Studio is attached. */
|
|
4151
|
+
studioAssigned?: StudioAssigned;
|
|
4152
|
+
/** Emitted when Studio is detached. */
|
|
4153
|
+
studioUnassigned?: StudioUnassigned;
|
|
4154
|
+
/**
|
|
4155
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
4156
|
+
* the actual URL.
|
|
4157
|
+
*
|
|
4158
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
4159
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
4160
|
+
*/
|
|
4161
|
+
urlChanged?: SiteUrlChanged;
|
|
4162
|
+
/** Site is marked as PurgedExternally */
|
|
4163
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
4164
|
+
/** Emitted when Odeditor is attached. */
|
|
4165
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
4166
|
+
/** Emitted when Odeditor is detached. */
|
|
4167
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
4168
|
+
/** Emitted when Picasso is attached. */
|
|
4169
|
+
picassoAssigned?: PicassoAssigned;
|
|
4170
|
+
/** Emitted when Picasso is detached. */
|
|
4171
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
4172
|
+
/** Emitted when Wixel is attached. */
|
|
4173
|
+
wixelAssigned?: WixelAssigned;
|
|
4174
|
+
/** Emitted when Wixel is detached. */
|
|
4175
|
+
wixelUnassigned?: WixelUnassigned;
|
|
4176
|
+
/** Emitted when StudioTwo is attached. */
|
|
4177
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
4178
|
+
/** Emitted when StudioTwo is detached. */
|
|
4179
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
4180
|
+
/** Emitted when media from user domain is enabled. */
|
|
4181
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
4182
|
+
/** Emitted when media from user domain is disabled. */
|
|
4183
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
4184
|
+
/** Emitted when Editorless is attached. */
|
|
4185
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
4186
|
+
/** Emitted when Editorless is detached. */
|
|
4187
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
4188
|
+
}
|
|
4189
|
+
interface Asset {
|
|
4190
|
+
/**
|
|
4191
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
4192
|
+
* @maxLength 36
|
|
4193
|
+
*/
|
|
4194
|
+
appDefId?: string;
|
|
4195
|
+
/**
|
|
4196
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
4197
|
+
* @maxLength 200
|
|
4198
|
+
*/
|
|
4199
|
+
instanceId?: string;
|
|
4200
|
+
/** An application state. */
|
|
4201
|
+
state?: StateWithLiterals;
|
|
4202
|
+
}
|
|
4203
|
+
declare enum State {
|
|
4204
|
+
UNKNOWN = "UNKNOWN",
|
|
4205
|
+
ENABLED = "ENABLED",
|
|
4206
|
+
DISABLED = "DISABLED",
|
|
4207
|
+
PENDING = "PENDING",
|
|
4208
|
+
DEMO = "DEMO"
|
|
4209
|
+
}
|
|
4210
|
+
/** @enumType */
|
|
4211
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
4212
|
+
interface SiteCreated {
|
|
4213
|
+
/**
|
|
4214
|
+
* A template identifier (empty if not created from a template).
|
|
4215
|
+
* @maxLength 36
|
|
4216
|
+
*/
|
|
4217
|
+
originTemplateId?: string;
|
|
4218
|
+
/**
|
|
4219
|
+
* An account id of the owner.
|
|
4220
|
+
* @format GUID
|
|
4221
|
+
*/
|
|
4222
|
+
ownerId?: string;
|
|
4223
|
+
/** A context in which meta site was created. */
|
|
4224
|
+
context?: SiteCreatedContextWithLiterals;
|
|
4225
|
+
/**
|
|
4226
|
+
* A meta site id from which this site was created.
|
|
4227
|
+
*
|
|
4228
|
+
* In case of a creation from a template it's a template id.
|
|
4229
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
4230
|
+
* @format GUID
|
|
4231
|
+
*/
|
|
4232
|
+
originMetaSiteId?: string | null;
|
|
4233
|
+
/**
|
|
4234
|
+
* A meta site name (URL slug).
|
|
4235
|
+
* @maxLength 20
|
|
4236
|
+
*/
|
|
4237
|
+
siteName?: string;
|
|
4238
|
+
/** A namespace. */
|
|
4239
|
+
namespace?: NamespaceWithLiterals;
|
|
4240
|
+
}
|
|
4241
|
+
declare enum SiteCreatedContext {
|
|
4242
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
4243
|
+
OTHER = "OTHER",
|
|
4244
|
+
/** A meta site was created from template. */
|
|
4245
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
4246
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
4247
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
4248
|
+
/** A copy of existing meta site. */
|
|
4249
|
+
DUPLICATE = "DUPLICATE",
|
|
4250
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
4251
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
4252
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
4253
|
+
FLASH = "FLASH"
|
|
4254
|
+
}
|
|
4255
|
+
/** @enumType */
|
|
4256
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
4257
|
+
declare enum Namespace {
|
|
4258
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
4259
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
4260
|
+
WIX = "WIX",
|
|
4261
|
+
/** 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. */
|
|
4262
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
4263
|
+
/** 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. */
|
|
4264
|
+
ALBUMS = "ALBUMS",
|
|
4265
|
+
/** 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. */
|
|
4266
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
4267
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4268
|
+
HOTELS = "HOTELS",
|
|
4269
|
+
/** 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. */
|
|
4270
|
+
CLUBS = "CLUBS",
|
|
4271
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4272
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
4273
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4274
|
+
DEV_SITE = "DEV_SITE",
|
|
4275
|
+
/** 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. */
|
|
4276
|
+
LOGOS = "LOGOS",
|
|
4277
|
+
/** 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. */
|
|
4278
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
4279
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4280
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
4281
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4282
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
4283
|
+
/**
|
|
4284
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
4285
|
+
*
|
|
4286
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
4287
|
+
*/
|
|
4288
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
4289
|
+
/**
|
|
4290
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
4291
|
+
* Will be accessible from Site List and will not have a website app.
|
|
4292
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
4293
|
+
*/
|
|
4294
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
4295
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
4296
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
4297
|
+
/** It is to be used in the Business First efforts. */
|
|
4298
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
4299
|
+
/** Bookings business flow with no site. */
|
|
4300
|
+
ANYWHERE = "ANYWHERE",
|
|
4301
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
4302
|
+
HEADLESS = "HEADLESS",
|
|
4303
|
+
/**
|
|
4304
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
4305
|
+
* The site will be used for account level CSM feature for enterprise
|
|
4306
|
+
*/
|
|
4307
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
4308
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
4309
|
+
RISE = "RISE",
|
|
4310
|
+
/**
|
|
4311
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
4312
|
+
* There's a blank site behind the scene but it's blank).
|
|
4313
|
+
* The Mobile company will be the owner of this namespace.
|
|
4314
|
+
*/
|
|
4315
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
4316
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
4317
|
+
NOWNIA = "NOWNIA",
|
|
4318
|
+
/**
|
|
4319
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
4320
|
+
* The Partners company owns this namespace.
|
|
4299
4321
|
*/
|
|
4300
|
-
|
|
4322
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
4323
|
+
/** Codux Headless Sites */
|
|
4324
|
+
CODUX = "CODUX",
|
|
4325
|
+
/** Bobb - AI Design Creator. */
|
|
4326
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
4327
|
+
/**
|
|
4328
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
4329
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
4330
|
+
*/
|
|
4331
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
4332
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4333
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
4334
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
4335
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
4336
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
4337
|
+
MIMIR = "MIMIR",
|
|
4338
|
+
/** Wix Twins platform. */
|
|
4339
|
+
TWINS = "TWINS",
|
|
4340
|
+
/** Wix Nano. */
|
|
4341
|
+
NANO = "NANO",
|
|
4342
|
+
/** Base44 headless sites. */
|
|
4343
|
+
BASE44 = "BASE44",
|
|
4344
|
+
/** Wix Channels Sites */
|
|
4345
|
+
CHANNELS = "CHANNELS",
|
|
4346
|
+
/** Nautilus platform. */
|
|
4347
|
+
NAUTILUS = "NAUTILUS"
|
|
4301
4348
|
}
|
|
4302
|
-
|
|
4303
|
-
|
|
4304
|
-
|
|
4305
|
-
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
|
|
4349
|
+
/** @enumType */
|
|
4350
|
+
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';
|
|
4351
|
+
/** Site transferred to another user. */
|
|
4352
|
+
interface SiteTransferred {
|
|
4353
|
+
/**
|
|
4354
|
+
* A previous owner id (user that transfers meta site).
|
|
4355
|
+
* @format GUID
|
|
4356
|
+
*/
|
|
4357
|
+
oldOwnerId?: string;
|
|
4358
|
+
/**
|
|
4359
|
+
* A new owner id (user that accepts meta site).
|
|
4360
|
+
* @format GUID
|
|
4361
|
+
*/
|
|
4362
|
+
newOwnerId?: string;
|
|
4363
|
+
}
|
|
4364
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
4365
|
+
interface SiteDeleted {
|
|
4366
|
+
/** A deletion context. */
|
|
4367
|
+
deleteContext?: DeleteContext;
|
|
4368
|
+
}
|
|
4369
|
+
interface DeleteContext {
|
|
4370
|
+
/** When the meta site was deleted. */
|
|
4371
|
+
dateDeleted?: Date | null;
|
|
4372
|
+
/** A status. */
|
|
4373
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
4374
|
+
/**
|
|
4375
|
+
* A reason (flow).
|
|
4376
|
+
* @maxLength 255
|
|
4377
|
+
*/
|
|
4378
|
+
deleteOrigin?: string;
|
|
4379
|
+
/**
|
|
4380
|
+
* A service that deleted it.
|
|
4381
|
+
* @maxLength 255
|
|
4382
|
+
*/
|
|
4383
|
+
initiatorId?: string | null;
|
|
4384
|
+
}
|
|
4385
|
+
declare enum DeleteStatus {
|
|
4386
|
+
UNKNOWN = "UNKNOWN",
|
|
4387
|
+
TRASH = "TRASH",
|
|
4388
|
+
DELETED = "DELETED",
|
|
4389
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
4390
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
4391
|
+
}
|
|
4392
|
+
/** @enumType */
|
|
4393
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
4394
|
+
/** Restoration of the meta site. */
|
|
4395
|
+
interface SiteUndeleted {
|
|
4396
|
+
}
|
|
4397
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
4398
|
+
interface SitePublished {
|
|
4399
|
+
}
|
|
4400
|
+
interface SiteUnpublished {
|
|
4401
|
+
/**
|
|
4402
|
+
* A list of URLs previously associated with the meta site.
|
|
4403
|
+
* @maxLength 4000
|
|
4404
|
+
* @maxSize 10000
|
|
4405
|
+
*/
|
|
4406
|
+
urls?: string[];
|
|
4407
|
+
}
|
|
4408
|
+
interface SiteMarkedAsTemplate {
|
|
4409
|
+
}
|
|
4410
|
+
interface SiteMarkedAsWixSite {
|
|
4411
|
+
}
|
|
4412
|
+
/**
|
|
4413
|
+
* Represents a service provisioned a site.
|
|
4414
|
+
*
|
|
4415
|
+
* Note on `origin_instance_id`:
|
|
4416
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
4417
|
+
* This is because of the following scenario:
|
|
4418
|
+
*
|
|
4419
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
4420
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
4421
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
4422
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
4423
|
+
* your site remains consistent with what you initially received and does not include any
|
|
4424
|
+
* changes made to the original template afterward.
|
|
4425
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
4426
|
+
*/
|
|
4427
|
+
interface ServiceProvisioned {
|
|
4428
|
+
/**
|
|
4429
|
+
* Either UUID or EmbeddedServiceType.
|
|
4430
|
+
* @maxLength 36
|
|
4431
|
+
*/
|
|
4432
|
+
appDefId?: string;
|
|
4433
|
+
/**
|
|
4434
|
+
* Not only UUID. Something here could be something weird.
|
|
4435
|
+
* @maxLength 36
|
|
4436
|
+
*/
|
|
4437
|
+
instanceId?: string;
|
|
4438
|
+
/**
|
|
4439
|
+
* An instance id from which this instance is originated.
|
|
4440
|
+
* @maxLength 36
|
|
4441
|
+
*/
|
|
4442
|
+
originInstanceId?: string;
|
|
4443
|
+
/**
|
|
4444
|
+
* A version.
|
|
4445
|
+
* @maxLength 500
|
|
4446
|
+
*/
|
|
4447
|
+
version?: string | null;
|
|
4448
|
+
/**
|
|
4449
|
+
* The origin meta site id
|
|
4450
|
+
* @format GUID
|
|
4451
|
+
*/
|
|
4452
|
+
originMetaSiteId?: string | null;
|
|
4453
|
+
}
|
|
4454
|
+
interface ServiceRemoved {
|
|
4455
|
+
/**
|
|
4456
|
+
* Either UUID or EmbeddedServiceType.
|
|
4457
|
+
* @maxLength 36
|
|
4458
|
+
*/
|
|
4459
|
+
appDefId?: string;
|
|
4460
|
+
/**
|
|
4461
|
+
* Not only UUID. Something here could be something weird.
|
|
4462
|
+
* @maxLength 36
|
|
4463
|
+
*/
|
|
4464
|
+
instanceId?: string;
|
|
4465
|
+
/**
|
|
4466
|
+
* A version.
|
|
4467
|
+
* @maxLength 500
|
|
4468
|
+
*/
|
|
4469
|
+
version?: string | null;
|
|
4470
|
+
}
|
|
4471
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
4472
|
+
interface SiteRenamed {
|
|
4473
|
+
/**
|
|
4474
|
+
* A new meta site name (URL slug).
|
|
4475
|
+
* @maxLength 20
|
|
4476
|
+
*/
|
|
4477
|
+
newSiteName?: string;
|
|
4478
|
+
/**
|
|
4479
|
+
* A previous meta site name (URL slug).
|
|
4480
|
+
* @maxLength 255
|
|
4481
|
+
*/
|
|
4482
|
+
oldSiteName?: string;
|
|
4483
|
+
}
|
|
4484
|
+
/**
|
|
4485
|
+
* Hard deletion of the meta site.
|
|
4486
|
+
*
|
|
4487
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
4488
|
+
*/
|
|
4489
|
+
interface SiteHardDeleted {
|
|
4490
|
+
/** A deletion context. */
|
|
4491
|
+
deleteContext?: DeleteContext;
|
|
4492
|
+
}
|
|
4493
|
+
interface NamespaceChanged {
|
|
4494
|
+
/** A previous namespace. */
|
|
4495
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
4496
|
+
/** A new namespace. */
|
|
4497
|
+
newNamespace?: NamespaceWithLiterals;
|
|
4498
|
+
}
|
|
4499
|
+
/** Assigned Studio editor */
|
|
4500
|
+
interface StudioAssigned {
|
|
4501
|
+
}
|
|
4502
|
+
/** Unassigned Studio editor */
|
|
4503
|
+
interface StudioUnassigned {
|
|
4504
|
+
}
|
|
4505
|
+
/**
|
|
4506
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
4507
|
+
*
|
|
4508
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
4509
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
4510
|
+
*
|
|
4511
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
4512
|
+
*/
|
|
4513
|
+
interface SiteUrlChanged {
|
|
4514
|
+
}
|
|
4515
|
+
/**
|
|
4516
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
4517
|
+
* Consumed by other teams to remove relevant data.
|
|
4518
|
+
*/
|
|
4519
|
+
interface SitePurgedExternally {
|
|
4520
|
+
/**
|
|
4521
|
+
* @maxLength 2048
|
|
4522
|
+
* @maxSize 100
|
|
4523
|
+
* @deprecated
|
|
4524
|
+
* @targetRemovalDate 2025-04-15
|
|
4525
|
+
*/
|
|
4526
|
+
appDefId?: string[];
|
|
4527
|
+
}
|
|
4528
|
+
/** Assigned Odeditor */
|
|
4529
|
+
interface OdeditorAssigned {
|
|
4530
|
+
}
|
|
4531
|
+
/** Unassigned Odeditor */
|
|
4532
|
+
interface OdeditorUnassigned {
|
|
4533
|
+
}
|
|
4534
|
+
/** Assigned Picasso editor */
|
|
4535
|
+
interface PicassoAssigned {
|
|
4536
|
+
}
|
|
4537
|
+
/** Unassigned Picasso */
|
|
4538
|
+
interface PicassoUnassigned {
|
|
4539
|
+
}
|
|
4540
|
+
/** Assigned Wixel */
|
|
4541
|
+
interface WixelAssigned {
|
|
4542
|
+
}
|
|
4543
|
+
/** Unassigned Wixel */
|
|
4544
|
+
interface WixelUnassigned {
|
|
4545
|
+
}
|
|
4546
|
+
/** Assigned StudioTwo */
|
|
4547
|
+
interface StudioTwoAssigned {
|
|
4548
|
+
}
|
|
4549
|
+
/** Unassigned StudioTwo */
|
|
4550
|
+
interface StudioTwoUnassigned {
|
|
4551
|
+
}
|
|
4552
|
+
/** Media from user domain is enabled. */
|
|
4553
|
+
interface UserDomainMediaEnabled {
|
|
4554
|
+
}
|
|
4555
|
+
/** Media from user domain is disabled. */
|
|
4556
|
+
interface UserDomainMediaDisabled {
|
|
4557
|
+
}
|
|
4558
|
+
/** Assigned Editorless */
|
|
4559
|
+
interface EditorlessAssigned {
|
|
4560
|
+
}
|
|
4561
|
+
/** Unassigned Editorless */
|
|
4562
|
+
interface EditorlessUnassigned {
|
|
4563
|
+
}
|
|
4564
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
4565
|
+
}
|
|
4566
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
4567
|
+
hasCustomConfigurations?: boolean;
|
|
4568
|
+
}
|
|
4569
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
4570
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
4571
|
+
sendCustomEmailConfigs?: boolean;
|
|
4572
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
4573
|
+
origin?: OriginWithLiterals;
|
|
4309
4574
|
}
|
|
4310
|
-
|
|
4311
|
-
|
|
4312
|
-
|
|
4313
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
4314
|
-
*/
|
|
4315
|
-
interface OrderTransactions {
|
|
4316
|
-
/**
|
|
4317
|
-
* Order ID.
|
|
4318
|
-
* @format GUID
|
|
4319
|
-
*/
|
|
4320
|
-
orderId?: string;
|
|
4321
|
-
/**
|
|
4322
|
-
* Record of payments made to the merchant.
|
|
4323
|
-
* @maxSize 100
|
|
4324
|
-
*/
|
|
4325
|
-
payments?: Payment[];
|
|
4326
|
-
/**
|
|
4327
|
-
* Record of refunds made to the buyer.
|
|
4328
|
-
* @maxSize 300
|
|
4329
|
-
*/
|
|
4330
|
-
refunds?: Refund[];
|
|
4575
|
+
declare enum Origin {
|
|
4576
|
+
OPT_IN = "OPT_IN",
|
|
4577
|
+
MIGRATION = "MIGRATION"
|
|
4331
4578
|
}
|
|
4332
|
-
|
|
4333
|
-
|
|
4334
|
-
|
|
4335
|
-
|
|
4336
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4337
|
-
/**
|
|
4338
|
-
* Payment ID.
|
|
4339
|
-
* @format GUID
|
|
4340
|
-
* @readonly
|
|
4341
|
-
*/
|
|
4342
|
-
_id?: string | null;
|
|
4343
|
-
/** 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. */
|
|
4344
|
-
_createdDate?: Date | null;
|
|
4345
|
-
/**
|
|
4346
|
-
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
4347
|
-
* @readonly
|
|
4348
|
-
*/
|
|
4349
|
-
_updatedDate?: Date | null;
|
|
4350
|
-
/** Payment amount. */
|
|
4351
|
-
amount?: Price;
|
|
4352
|
-
/**
|
|
4353
|
-
* Whether refunds for this payment are disabled.
|
|
4354
|
-
* + `true`: This payment is not refundable.
|
|
4355
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
4356
|
-
*/
|
|
4357
|
-
refundDisabled?: boolean;
|
|
4579
|
+
/** @enumType */
|
|
4580
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
4581
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
4582
|
+
success?: boolean;
|
|
4358
4583
|
}
|
|
4359
|
-
|
|
4360
|
-
interface PaymentPaymentDetailsOneOf {
|
|
4361
|
-
/** Regular payment details. */
|
|
4362
|
-
regularPaymentDetails?: RegularPaymentDetails;
|
|
4363
|
-
/** Gift card payment details. */
|
|
4364
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4584
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
4365
4585
|
}
|
|
4366
|
-
|
|
4367
|
-
|
|
4586
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
4587
|
+
inPopulation?: boolean;
|
|
4368
4588
|
}
|
|
4369
|
-
interface
|
|
4370
|
-
/** Credit card details. */
|
|
4371
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4589
|
+
interface PreparePaymentCollectionRequest {
|
|
4372
4590
|
/**
|
|
4373
|
-
*
|
|
4591
|
+
* Ecom order ID.
|
|
4592
|
+
* @minLength 1
|
|
4374
4593
|
* @maxLength 100
|
|
4375
4594
|
*/
|
|
4376
|
-
|
|
4595
|
+
ecomOrderId: string;
|
|
4596
|
+
/** Amount to collect */
|
|
4597
|
+
amount: Price;
|
|
4377
4598
|
/**
|
|
4378
|
-
*
|
|
4379
|
-
*
|
|
4380
|
-
*
|
|
4599
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4600
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
4601
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4381
4602
|
*/
|
|
4382
|
-
|
|
4603
|
+
paymentGatewayOrderId?: string | null;
|
|
4383
4604
|
/**
|
|
4384
|
-
*
|
|
4385
|
-
*
|
|
4386
|
-
*
|
|
4387
|
-
*
|
|
4388
|
-
* @
|
|
4389
|
-
* @
|
|
4390
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
4391
|
-
* Non-exhaustive list of supported values:
|
|
4392
|
-
* + `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`
|
|
4393
|
-
* @replacedBy payment_method_name
|
|
4394
|
-
* @targetRemovalDate 2026-07-01
|
|
4605
|
+
* Whether to delay capture of the payment.
|
|
4606
|
+
* Default: false
|
|
4607
|
+
* @deprecated Whether to delay capture of the payment.
|
|
4608
|
+
* Default: false
|
|
4609
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4610
|
+
* @targetRemovalDate 2024-09-30
|
|
4395
4611
|
*/
|
|
4396
|
-
|
|
4612
|
+
delayedCapture?: boolean;
|
|
4613
|
+
/** Delayed capture payment settings */
|
|
4614
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4615
|
+
}
|
|
4616
|
+
interface RedirectUrls {
|
|
4397
4617
|
/**
|
|
4398
|
-
*
|
|
4399
|
-
* @
|
|
4618
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4619
|
+
* @format WEB_URL
|
|
4400
4620
|
*/
|
|
4401
|
-
|
|
4402
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
4403
|
-
offlinePayment?: boolean;
|
|
4404
|
-
/** Payment status. */
|
|
4405
|
-
status?: TransactionStatusWithLiterals;
|
|
4621
|
+
successUrl?: string | null;
|
|
4406
4622
|
/**
|
|
4407
|
-
*
|
|
4408
|
-
* @
|
|
4623
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4624
|
+
* @format WEB_URL
|
|
4409
4625
|
*/
|
|
4410
|
-
|
|
4411
|
-
/** Authorization details. */
|
|
4412
|
-
authorizationDetails?: AuthorizationDetails;
|
|
4626
|
+
cancelUrl?: string | null;
|
|
4413
4627
|
/**
|
|
4414
|
-
*
|
|
4415
|
-
* @
|
|
4628
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4629
|
+
* @format WEB_URL
|
|
4416
4630
|
*/
|
|
4417
|
-
|
|
4418
|
-
/** Platform fee amount associated with this payment. */
|
|
4419
|
-
platformFee?: Price;
|
|
4631
|
+
errorUrl?: string | null;
|
|
4420
4632
|
/**
|
|
4421
|
-
*
|
|
4422
|
-
*
|
|
4423
|
-
* + `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`
|
|
4633
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4634
|
+
* @format WEB_URL
|
|
4424
4635
|
*/
|
|
4425
|
-
|
|
4636
|
+
pendingUrl?: string | null;
|
|
4426
4637
|
}
|
|
4427
|
-
|
|
4428
|
-
|
|
4429
|
-
|
|
4430
|
-
|
|
4638
|
+
interface DelayedCaptureSettings {
|
|
4639
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4640
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
4641
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4642
|
+
delayDuration?: Duration;
|
|
4431
4643
|
}
|
|
4432
|
-
declare enum
|
|
4433
|
-
|
|
4434
|
-
|
|
4435
|
-
|
|
4436
|
-
|
|
4437
|
-
CANCELED = "CANCELED",
|
|
4438
|
-
DECLINED = "DECLINED",
|
|
4439
|
-
REFUNDED = "REFUNDED",
|
|
4440
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4441
|
-
AUTHORIZED = "AUTHORIZED",
|
|
4442
|
-
VOIDED = "VOIDED"
|
|
4644
|
+
declare enum ScheduledAction {
|
|
4645
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
4646
|
+
VOID = "VOID",
|
|
4647
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
4648
|
+
CAPTURE = "CAPTURE"
|
|
4443
4649
|
}
|
|
4444
4650
|
/** @enumType */
|
|
4445
|
-
type
|
|
4446
|
-
interface
|
|
4447
|
-
/**
|
|
4448
|
-
* The last 4 digits of the card number.
|
|
4449
|
-
* @maxLength 4
|
|
4450
|
-
*/
|
|
4451
|
-
lastFourDigits?: string | null;
|
|
4452
|
-
/**
|
|
4453
|
-
* Card issuer's brand.
|
|
4454
|
-
* @maxLength 100
|
|
4455
|
-
*/
|
|
4456
|
-
brand?: string | null;
|
|
4457
|
-
}
|
|
4458
|
-
interface AuthorizationDetails {
|
|
4459
|
-
/**
|
|
4460
|
-
* Whether the authorized payment is of a delayed capture.
|
|
4461
|
-
* @readonly
|
|
4462
|
-
*/
|
|
4463
|
-
delayedCapture?: boolean;
|
|
4464
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4465
|
-
authorizedDate?: Date | null;
|
|
4466
|
-
/**
|
|
4467
|
-
* List of captures associated with payment
|
|
4468
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
4469
|
-
* @maxSize 1
|
|
4470
|
-
*/
|
|
4471
|
-
captures?: AuthorizationCapture[];
|
|
4472
|
-
/** Void associated with payment */
|
|
4473
|
-
void?: AuthorizationVoid;
|
|
4474
|
-
/** Scheduled action for this transaction */
|
|
4475
|
-
scheduledAction?: V1ScheduledAction;
|
|
4476
|
-
}
|
|
4477
|
-
interface AuthorizationCapture {
|
|
4478
|
-
/**
|
|
4479
|
-
* Capture ID.
|
|
4480
|
-
* @format GUID
|
|
4481
|
-
* @readonly
|
|
4482
|
-
*/
|
|
4483
|
-
_id?: string | null;
|
|
4484
|
-
/** Status of this capture action */
|
|
4485
|
-
status?: AuthorizationCaptureStatusWithLiterals;
|
|
4651
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4652
|
+
interface Duration {
|
|
4486
4653
|
/**
|
|
4487
|
-
* Amount of
|
|
4488
|
-
* @
|
|
4654
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4655
|
+
* @min 1
|
|
4489
4656
|
*/
|
|
4490
|
-
|
|
4491
|
-
/**
|
|
4492
|
-
|
|
4493
|
-
/** In case of status is FAILED may contain failure details */
|
|
4494
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4495
|
-
}
|
|
4496
|
-
declare enum AuthorizationCaptureStatus {
|
|
4497
|
-
/** Capture operation still in progress. */
|
|
4498
|
-
PENDING = "PENDING",
|
|
4499
|
-
/** Capture operation succeeded. */
|
|
4500
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4501
|
-
/** Capture operation failed. */
|
|
4502
|
-
FAILED = "FAILED"
|
|
4503
|
-
}
|
|
4504
|
-
/** @enumType */
|
|
4505
|
-
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
4506
|
-
interface AuthorizationActionFailureDetails {
|
|
4507
|
-
/** @maxLength 100 */
|
|
4508
|
-
failureCode?: string;
|
|
4509
|
-
}
|
|
4510
|
-
interface AuthorizationVoid {
|
|
4511
|
-
/** Status of this void action */
|
|
4512
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
4513
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
4514
|
-
voidedDate?: Date | null;
|
|
4515
|
-
/** In case of status is FAILED may contain failure details */
|
|
4516
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
4517
|
-
/** Reason of void action */
|
|
4518
|
-
reason?: ReasonWithLiterals;
|
|
4657
|
+
count?: number;
|
|
4658
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4659
|
+
unit?: DurationUnitWithLiterals;
|
|
4519
4660
|
}
|
|
4520
|
-
declare enum
|
|
4521
|
-
|
|
4522
|
-
|
|
4523
|
-
|
|
4524
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4525
|
-
/** Void operation failed. */
|
|
4526
|
-
FAILED = "FAILED"
|
|
4661
|
+
declare enum DurationUnit {
|
|
4662
|
+
MINUTES = "MINUTES",
|
|
4663
|
+
HOURS = "HOURS",
|
|
4664
|
+
DAYS = "DAYS"
|
|
4527
4665
|
}
|
|
4528
4666
|
/** @enumType */
|
|
4529
|
-
type
|
|
4530
|
-
|
|
4531
|
-
|
|
4532
|
-
|
|
4533
|
-
MANUAL = "MANUAL",
|
|
4534
|
-
/** Authorization passed execution date. */
|
|
4535
|
-
SCHEDULED = "SCHEDULED"
|
|
4667
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4668
|
+
interface PreparePaymentCollectionResponse {
|
|
4669
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4670
|
+
paymentGatewayOrderId?: string;
|
|
4536
4671
|
}
|
|
4537
|
-
|
|
4538
|
-
|
|
4539
|
-
|
|
4540
|
-
|
|
4541
|
-
|
|
4542
|
-
|
|
4543
|
-
|
|
4672
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4673
|
+
/**
|
|
4674
|
+
* Ecom order ID.
|
|
4675
|
+
* @minLength 1
|
|
4676
|
+
* @maxLength 100
|
|
4677
|
+
*/
|
|
4678
|
+
ecomOrderId: string;
|
|
4544
4679
|
}
|
|
4545
|
-
|
|
4546
|
-
|
|
4547
|
-
|
|
4680
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4681
|
+
/** Payment collectability status */
|
|
4682
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4683
|
+
/** Collectable order amount */
|
|
4684
|
+
amount?: Price;
|
|
4685
|
+
}
|
|
4686
|
+
declare enum PaymentCollectabilityStatus {
|
|
4687
|
+
UNKNOWN = "UNKNOWN",
|
|
4688
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4689
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4690
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4691
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4692
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4693
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4694
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4695
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4696
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4697
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4698
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
|
|
4548
4699
|
}
|
|
4549
4700
|
/** @enumType */
|
|
4550
|
-
type
|
|
4551
|
-
interface
|
|
4701
|
+
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';
|
|
4702
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4552
4703
|
/**
|
|
4553
|
-
*
|
|
4554
|
-
* @
|
|
4555
|
-
* @
|
|
4556
|
-
* @immutable
|
|
4704
|
+
* Order ID.
|
|
4705
|
+
* @minLength 1
|
|
4706
|
+
* @maxLength 100
|
|
4557
4707
|
*/
|
|
4558
|
-
|
|
4708
|
+
orderId: string;
|
|
4709
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4710
|
+
amount: Price;
|
|
4711
|
+
}
|
|
4712
|
+
/**
|
|
4713
|
+
* User-defined payment method name.
|
|
4714
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4715
|
+
*/
|
|
4716
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4717
|
+
/** Predefined payment method. */
|
|
4718
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4559
4719
|
/**
|
|
4560
|
-
*
|
|
4561
|
-
*
|
|
4562
|
-
*
|
|
4720
|
+
* Custom payment method name provided by user.
|
|
4721
|
+
*
|
|
4722
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4723
|
+
* @minLength 1
|
|
4724
|
+
* @maxLength 100
|
|
4563
4725
|
*/
|
|
4564
|
-
|
|
4726
|
+
custom?: string | null;
|
|
4727
|
+
}
|
|
4728
|
+
/** @oneof */
|
|
4729
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4730
|
+
/** Predefined payment method. */
|
|
4731
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4565
4732
|
/**
|
|
4566
|
-
*
|
|
4567
|
-
*
|
|
4733
|
+
* Custom payment method name provided by user.
|
|
4734
|
+
*
|
|
4735
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4736
|
+
* @minLength 1
|
|
4737
|
+
* @maxLength 100
|
|
4568
4738
|
*/
|
|
4569
|
-
|
|
4739
|
+
custom?: string | null;
|
|
4740
|
+
}
|
|
4741
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
4742
|
+
declare enum PredefinedPaymentMethod {
|
|
4743
|
+
/** Cash payment. */
|
|
4744
|
+
CASH = "CASH",
|
|
4745
|
+
/** Bank transfer. */
|
|
4746
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4747
|
+
/** Payment by check. */
|
|
4748
|
+
CHECK = "CHECK"
|
|
4749
|
+
}
|
|
4750
|
+
/** @enumType */
|
|
4751
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4752
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
4753
|
+
}
|
|
4754
|
+
interface MarkOrderAsPaidRequest {
|
|
4570
4755
|
/**
|
|
4571
|
-
*
|
|
4572
|
-
* @
|
|
4573
|
-
* @
|
|
4756
|
+
* Ecom order ID.
|
|
4757
|
+
* @minLength 1
|
|
4758
|
+
* @maxLength 100
|
|
4574
4759
|
*/
|
|
4575
|
-
|
|
4760
|
+
ecomOrderId: string;
|
|
4761
|
+
}
|
|
4762
|
+
interface MarkOrderAsPaidResponse {
|
|
4763
|
+
/** Updated order. */
|
|
4764
|
+
order?: Order;
|
|
4765
|
+
}
|
|
4766
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
4576
4767
|
/**
|
|
4577
|
-
*
|
|
4578
|
-
* @
|
|
4768
|
+
* IDs of orders to mark as paid.
|
|
4769
|
+
* @minSize 1
|
|
4770
|
+
* @maxSize 100
|
|
4771
|
+
* @minLength 1
|
|
4772
|
+
* @maxLength 100
|
|
4579
4773
|
*/
|
|
4580
|
-
|
|
4774
|
+
ecomOrderIds: string[];
|
|
4775
|
+
}
|
|
4776
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
4581
4777
|
/**
|
|
4582
|
-
*
|
|
4583
|
-
*
|
|
4584
|
-
* Default: `"APPROVED"`.
|
|
4778
|
+
* Items updated by the bulk action.
|
|
4779
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
4585
4780
|
*/
|
|
4586
|
-
|
|
4781
|
+
results?: BulkOrderResult[];
|
|
4782
|
+
/** Bulk action metadata. */
|
|
4783
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
4784
|
+
}
|
|
4785
|
+
interface BulkOrderResult {
|
|
4786
|
+
/** Item metadata. */
|
|
4787
|
+
itemMetadata?: ItemMetadata;
|
|
4587
4788
|
/**
|
|
4588
|
-
*
|
|
4589
|
-
*
|
|
4590
|
-
*
|
|
4591
|
-
* @immutable
|
|
4789
|
+
* Updated order.
|
|
4790
|
+
*
|
|
4791
|
+
* Returned when `returnFullEntity = true`.
|
|
4592
4792
|
*/
|
|
4593
|
-
|
|
4793
|
+
item?: Order;
|
|
4594
4794
|
}
|
|
4595
|
-
|
|
4596
|
-
/**
|
|
4597
|
-
|
|
4598
|
-
/**
|
|
4599
|
-
|
|
4795
|
+
interface ItemMetadata {
|
|
4796
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
4797
|
+
_id?: string | null;
|
|
4798
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
4799
|
+
originalIndex?: number;
|
|
4800
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
4801
|
+
success?: boolean;
|
|
4802
|
+
/** Details about the error in case of failure. */
|
|
4803
|
+
error?: ApplicationError;
|
|
4600
4804
|
}
|
|
4601
|
-
|
|
4602
|
-
|
|
4603
|
-
|
|
4805
|
+
interface ApplicationError {
|
|
4806
|
+
/** Error code. */
|
|
4807
|
+
code?: string;
|
|
4808
|
+
/** Description of the error. */
|
|
4809
|
+
description?: string;
|
|
4810
|
+
/** Data related to the error. */
|
|
4811
|
+
data?: Record<string, any> | null;
|
|
4812
|
+
}
|
|
4813
|
+
interface BulkActionMetadata {
|
|
4814
|
+
/** Number of items that were successfully processed. */
|
|
4815
|
+
totalSuccesses?: number;
|
|
4816
|
+
/** Number of items that couldn't be processed. */
|
|
4817
|
+
totalFailures?: number;
|
|
4818
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
4819
|
+
undetailedFailures?: number;
|
|
4820
|
+
}
|
|
4821
|
+
interface GetRefundabilityStatusRequest {
|
|
4604
4822
|
/**
|
|
4605
|
-
*
|
|
4823
|
+
* Order ID.
|
|
4824
|
+
* @minLength 1
|
|
4606
4825
|
* @maxLength 100
|
|
4607
4826
|
*/
|
|
4608
|
-
|
|
4827
|
+
ecomOrderId: string;
|
|
4828
|
+
}
|
|
4829
|
+
interface GetRefundabilityStatusResponse {
|
|
4609
4830
|
/**
|
|
4610
|
-
*
|
|
4611
|
-
* @
|
|
4831
|
+
* Refundability details.
|
|
4832
|
+
* @maxSize 300
|
|
4612
4833
|
*/
|
|
4613
|
-
|
|
4834
|
+
refundabilities?: Refundability[];
|
|
4614
4835
|
/**
|
|
4615
|
-
*
|
|
4616
|
-
*
|
|
4617
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
4836
|
+
* Whether the order supports refunding per item.
|
|
4837
|
+
* @deprecated
|
|
4618
4838
|
*/
|
|
4619
|
-
|
|
4839
|
+
refundablePerItem?: boolean;
|
|
4840
|
+
}
|
|
4841
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4842
|
+
/** Reason why payment is not refundable. */
|
|
4843
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4844
|
+
/** Reason why payment is only refundable manually. */
|
|
4845
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4846
|
+
/** Payment ID. */
|
|
4847
|
+
paymentId?: string;
|
|
4848
|
+
/** Payment refundability status. */
|
|
4849
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
4850
|
+
/** Link to payment provider dashboard. */
|
|
4851
|
+
providerLink?: string | null;
|
|
4852
|
+
}
|
|
4853
|
+
/** @oneof */
|
|
4854
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
4855
|
+
/** Reason why payment is not refundable. */
|
|
4856
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
4857
|
+
/** Reason why payment is only refundable manually. */
|
|
4858
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
4859
|
+
}
|
|
4860
|
+
declare enum RefundableStatus {
|
|
4861
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
4862
|
+
MANUAL = "MANUAL",
|
|
4863
|
+
REFUNDABLE = "REFUNDABLE"
|
|
4864
|
+
}
|
|
4865
|
+
/** @enumType */
|
|
4866
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
4867
|
+
declare enum NonRefundableReason {
|
|
4868
|
+
NONE = "NONE",
|
|
4869
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
4870
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
4871
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
4872
|
+
NOT_PAID = "NOT_PAID",
|
|
4873
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
4874
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
4875
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
4876
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
4877
|
+
FORBIDDEN = "FORBIDDEN",
|
|
4878
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
4879
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
4880
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
4881
|
+
}
|
|
4882
|
+
/** @enumType */
|
|
4883
|
+
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';
|
|
4884
|
+
declare enum ManuallyRefundableReason {
|
|
4885
|
+
EXPIRED = "EXPIRED",
|
|
4886
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
4887
|
+
OFFLINE = "OFFLINE",
|
|
4888
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
4620
4889
|
}
|
|
4621
|
-
|
|
4890
|
+
/** @enumType */
|
|
4891
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
4892
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
4622
4893
|
/**
|
|
4623
|
-
*
|
|
4894
|
+
* Ecom order ID.
|
|
4895
|
+
* @minLength 1
|
|
4624
4896
|
* @maxLength 100
|
|
4625
4897
|
*/
|
|
4626
|
-
|
|
4627
|
-
/**
|
|
4628
|
-
|
|
4629
|
-
* @format GUID
|
|
4630
|
-
*/
|
|
4631
|
-
appId?: string;
|
|
4632
|
-
/**
|
|
4633
|
-
* Whether the gift card is voided.
|
|
4634
|
-
* @readonly
|
|
4635
|
-
*/
|
|
4636
|
-
voided?: boolean;
|
|
4898
|
+
ecomOrderId: string;
|
|
4899
|
+
/** Information about the user who initiated the payment. */
|
|
4900
|
+
chargedBy?: ChargedBy;
|
|
4637
4901
|
}
|
|
4638
|
-
interface
|
|
4902
|
+
interface ChargedBy {
|
|
4639
4903
|
/**
|
|
4640
|
-
*
|
|
4641
|
-
* @
|
|
4642
|
-
* @maxLength 100
|
|
4904
|
+
* ID - id of the user who initiated the payment
|
|
4905
|
+
* @format GUID
|
|
4643
4906
|
*/
|
|
4644
|
-
|
|
4907
|
+
_id?: string;
|
|
4645
4908
|
/**
|
|
4646
|
-
*
|
|
4909
|
+
* Full name - name of the user who initiated the payment
|
|
4647
4910
|
* @minLength 1
|
|
4648
|
-
* @maxLength
|
|
4911
|
+
* @maxLength 200
|
|
4649
4912
|
*/
|
|
4650
|
-
|
|
4651
|
-
|
|
4652
|
-
|
|
4653
|
-
/**
|
|
4654
|
-
|
|
4913
|
+
fullName?: string | null;
|
|
4914
|
+
}
|
|
4915
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
4916
|
+
/** ID of the order created in the payment gateway */
|
|
4917
|
+
paymentGatewayOrderId?: string;
|
|
4918
|
+
}
|
|
4919
|
+
interface ChargeMembershipsRequest {
|
|
4655
4920
|
/**
|
|
4656
|
-
*
|
|
4921
|
+
* Order ID.
|
|
4657
4922
|
* @minLength 1
|
|
4658
4923
|
* @maxLength 100
|
|
4659
4924
|
*/
|
|
4660
|
-
|
|
4661
|
-
/**
|
|
4662
|
-
* Whether the membership is voided.
|
|
4663
|
-
* @readonly
|
|
4664
|
-
*/
|
|
4665
|
-
voided?: boolean;
|
|
4666
|
-
/**
|
|
4667
|
-
* ID of the application providing this payment option.
|
|
4668
|
-
* @format GUID
|
|
4669
|
-
*/
|
|
4670
|
-
providerAppId?: string;
|
|
4671
|
-
}
|
|
4672
|
-
declare enum MembershipPaymentStatus {
|
|
4673
|
-
/** Payment was charged. */
|
|
4674
|
-
CHARGED = "CHARGED",
|
|
4675
|
-
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
4676
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
4677
|
-
/** Payment is pending. */
|
|
4678
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
4679
|
-
/** Payment was voided. */
|
|
4680
|
-
VOIDED = "VOIDED"
|
|
4681
|
-
}
|
|
4682
|
-
/** @enumType */
|
|
4683
|
-
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
4684
|
-
interface WixReceiptInfo {
|
|
4925
|
+
ecomOrderId: string;
|
|
4685
4926
|
/**
|
|
4686
|
-
*
|
|
4927
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
4928
|
+
* but a user which is using the membership on behalf of the a member
|
|
4687
4929
|
* @format GUID
|
|
4688
4930
|
*/
|
|
4689
|
-
|
|
4931
|
+
memberId: string;
|
|
4690
4932
|
/**
|
|
4691
|
-
*
|
|
4692
|
-
* @
|
|
4693
|
-
* @
|
|
4933
|
+
* List of items to be paid by memberships
|
|
4934
|
+
* @minSize 1
|
|
4935
|
+
* @maxSize 300
|
|
4694
4936
|
*/
|
|
4695
|
-
|
|
4937
|
+
membershipCharges?: MembershipChargeItem[];
|
|
4696
4938
|
}
|
|
4697
|
-
interface
|
|
4939
|
+
interface MembershipChargeItem {
|
|
4698
4940
|
/**
|
|
4699
|
-
*
|
|
4941
|
+
* The id of used membership
|
|
4942
|
+
* @minLength 1
|
|
4700
4943
|
* @maxLength 100
|
|
4701
4944
|
*/
|
|
4702
|
-
|
|
4945
|
+
membershipId?: string;
|
|
4703
4946
|
/**
|
|
4704
|
-
* ID of the
|
|
4947
|
+
* ID of the application providing this payment option
|
|
4705
4948
|
* @format GUID
|
|
4706
4949
|
*/
|
|
4707
|
-
appId?: string
|
|
4950
|
+
appId?: string;
|
|
4951
|
+
/** The name of used membership */
|
|
4952
|
+
membershipName?: MembershipName;
|
|
4953
|
+
/** Additional data about this membership */
|
|
4954
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
4955
|
+
/** Catalog and item reference info. */
|
|
4956
|
+
catalogReference?: CatalogReference;
|
|
4957
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
4958
|
+
serviceProperties?: ServiceProperties;
|
|
4708
4959
|
/**
|
|
4709
|
-
*
|
|
4960
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
4961
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
4962
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
4710
4963
|
* @minLength 1
|
|
4711
|
-
* @maxLength
|
|
4712
|
-
*/
|
|
4713
|
-
displayNumber?: string | null;
|
|
4714
|
-
}
|
|
4715
|
-
interface CashRoundingDetails {
|
|
4716
|
-
}
|
|
4717
|
-
declare enum PaymentStatus {
|
|
4718
|
-
APPROVED = "APPROVED",
|
|
4719
|
-
PENDING = "PENDING",
|
|
4720
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
4721
|
-
CANCELED = "CANCELED",
|
|
4722
|
-
DECLINED = "DECLINED",
|
|
4723
|
-
REFUNDED = "REFUNDED",
|
|
4724
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
4725
|
-
AUTHORIZED = "AUTHORIZED",
|
|
4726
|
-
VOIDED = "VOIDED"
|
|
4727
|
-
}
|
|
4728
|
-
/** @enumType */
|
|
4729
|
-
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
4730
|
-
interface Refund {
|
|
4731
|
-
/**
|
|
4732
|
-
* Refund ID.
|
|
4733
|
-
* @format GUID
|
|
4734
|
-
* @readonly
|
|
4735
|
-
*/
|
|
4736
|
-
_id?: string;
|
|
4737
|
-
/**
|
|
4738
|
-
* List of transactions.
|
|
4739
|
-
* @maxSize 50
|
|
4740
|
-
*/
|
|
4741
|
-
transactions?: RefundTransaction[];
|
|
4742
|
-
/** Refund business details. */
|
|
4743
|
-
details?: RefundDetails;
|
|
4744
|
-
/**
|
|
4745
|
-
* 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.
|
|
4746
|
-
* @readonly
|
|
4747
|
-
* @immutable
|
|
4748
|
-
*/
|
|
4749
|
-
_createdDate?: Date | null;
|
|
4750
|
-
/**
|
|
4751
|
-
* Aggregated refund summary.
|
|
4752
|
-
* @readonly
|
|
4964
|
+
* @maxLength 36
|
|
4753
4965
|
*/
|
|
4754
|
-
|
|
4966
|
+
rootCatalogItemId?: string | null;
|
|
4755
4967
|
/**
|
|
4756
|
-
*
|
|
4757
|
-
* @
|
|
4758
|
-
* @
|
|
4759
|
-
* @immutable
|
|
4968
|
+
* line item id of Checkout/Order line item
|
|
4969
|
+
* @minLength 1
|
|
4970
|
+
* @maxLength 100
|
|
4760
4971
|
*/
|
|
4761
|
-
|
|
4972
|
+
lineItemId?: string;
|
|
4762
4973
|
}
|
|
4763
|
-
interface
|
|
4974
|
+
interface MembershipName {
|
|
4764
4975
|
/**
|
|
4765
|
-
*
|
|
4766
|
-
* @
|
|
4767
|
-
* @immutable
|
|
4976
|
+
* Membership name.
|
|
4977
|
+
* @maxLength 100
|
|
4768
4978
|
*/
|
|
4769
|
-
|
|
4979
|
+
original?: string;
|
|
4770
4980
|
/**
|
|
4771
|
-
*
|
|
4772
|
-
* @
|
|
4981
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
4982
|
+
* @maxLength 100
|
|
4773
4983
|
*/
|
|
4774
|
-
|
|
4775
|
-
|
|
4776
|
-
|
|
4777
|
-
/** Optional details of current refund status. */
|
|
4778
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
4984
|
+
translated?: string | null;
|
|
4985
|
+
}
|
|
4986
|
+
interface ServiceProperties {
|
|
4779
4987
|
/**
|
|
4780
|
-
*
|
|
4781
|
-
*
|
|
4782
|
-
* @format GUID
|
|
4988
|
+
* 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.
|
|
4989
|
+
* For example, the start time of a class.
|
|
4783
4990
|
*/
|
|
4784
|
-
|
|
4785
|
-
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
4786
|
-
providerRefundId?: string | null;
|
|
4991
|
+
scheduledDate?: Date | null;
|
|
4787
4992
|
/**
|
|
4788
|
-
*
|
|
4789
|
-
* @
|
|
4993
|
+
* 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.
|
|
4994
|
+
* @min 1
|
|
4995
|
+
* @max 10000
|
|
4790
4996
|
*/
|
|
4791
|
-
|
|
4997
|
+
numberOfParticipants?: number | null;
|
|
4792
4998
|
}
|
|
4793
|
-
|
|
4794
|
-
declare enum RefundStatus {
|
|
4795
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
4796
|
-
PENDING = "PENDING",
|
|
4797
|
-
/** Refund transaction succeeded. */
|
|
4798
|
-
SUCCEEDED = "SUCCEEDED",
|
|
4799
|
-
/** Refund transaction failed. */
|
|
4800
|
-
FAILED = "FAILED",
|
|
4801
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
4802
|
-
SCHEDULED = "SCHEDULED",
|
|
4803
|
-
/** Refund was initiated on payment provider side. */
|
|
4804
|
-
STARTED = "STARTED"
|
|
4999
|
+
interface ChargeMembershipsResponse {
|
|
4805
5000
|
}
|
|
4806
|
-
|
|
4807
|
-
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
4808
|
-
interface RefundStatusInfo {
|
|
4809
|
-
/**
|
|
4810
|
-
* Reason code for the refund's current status.
|
|
4811
|
-
*
|
|
4812
|
-
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
4813
|
-
* @minLength 1
|
|
4814
|
-
* @maxLength 10
|
|
4815
|
-
*/
|
|
4816
|
-
paymentGatewayReasonCode?: string | null;
|
|
5001
|
+
interface TriggerRefundRequest {
|
|
4817
5002
|
/**
|
|
4818
|
-
*
|
|
5003
|
+
* The order this refund related to
|
|
4819
5004
|
* @minLength 1
|
|
4820
|
-
* @maxLength
|
|
5005
|
+
* @maxLength 100
|
|
4821
5006
|
*/
|
|
4822
|
-
|
|
4823
|
-
|
|
4824
|
-
|
|
4825
|
-
|
|
4826
|
-
|
|
4827
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
4828
|
-
pendingRefund?: Price;
|
|
4829
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
4830
|
-
refunded?: Price;
|
|
4831
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
4832
|
-
failedRefundAmount?: Price;
|
|
4833
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
4834
|
-
pending?: boolean;
|
|
4835
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
4836
|
-
breakdown?: RefundItemsBreakdown;
|
|
4837
|
-
}
|
|
4838
|
-
interface RefundItemsBreakdown {
|
|
4839
|
-
/**
|
|
4840
|
-
* Refunded line items and the amount refunded for each.
|
|
4841
|
-
* @maxSize 300
|
|
5007
|
+
ecomOrderId: string;
|
|
5008
|
+
/**
|
|
5009
|
+
* Refund operations information
|
|
5010
|
+
* @minSize 1
|
|
5011
|
+
* @maxSize 1
|
|
4842
5012
|
*/
|
|
4843
|
-
|
|
5013
|
+
payments: PaymentRefund[];
|
|
5014
|
+
/** Business model of a refund */
|
|
5015
|
+
details?: RefundDetails;
|
|
5016
|
+
/** Side effect details related to refund */
|
|
5017
|
+
sideEffects?: RefundSideEffects;
|
|
4844
5018
|
}
|
|
4845
|
-
interface
|
|
5019
|
+
interface PaymentRefund {
|
|
4846
5020
|
/**
|
|
4847
|
-
*
|
|
5021
|
+
* Specific payment within the order to refund
|
|
4848
5022
|
* @format GUID
|
|
4849
5023
|
*/
|
|
4850
|
-
|
|
4851
|
-
/**
|
|
4852
|
-
|
|
5024
|
+
paymentId?: string;
|
|
5025
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5026
|
+
amount?: Price;
|
|
5027
|
+
/**
|
|
5028
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5029
|
+
* 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.
|
|
5030
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5031
|
+
*/
|
|
5032
|
+
externalRefund?: boolean;
|
|
4853
5033
|
}
|
|
4854
|
-
interface
|
|
5034
|
+
interface RefundSideEffects {
|
|
5035
|
+
/** Inventory restock details as part of this refund. */
|
|
5036
|
+
restockInfo?: RestockInfo;
|
|
5037
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
5038
|
+
sendOrderRefundedEmail?: boolean;
|
|
4855
5039
|
/**
|
|
4856
|
-
*
|
|
5040
|
+
* Custom message added to the refund confirmation email.
|
|
4857
5041
|
* @minLength 1
|
|
4858
|
-
* @maxLength
|
|
5042
|
+
* @maxLength 1000
|
|
4859
5043
|
*/
|
|
4860
|
-
|
|
5044
|
+
customMessage?: string | null;
|
|
5045
|
+
}
|
|
5046
|
+
interface RestockInfo {
|
|
5047
|
+
/** Restock type. */
|
|
5048
|
+
type?: RestockTypeWithLiterals;
|
|
4861
5049
|
/**
|
|
4862
|
-
*
|
|
5050
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
4863
5051
|
* @maxSize 300
|
|
4864
5052
|
*/
|
|
4865
|
-
|
|
4866
|
-
/** Should include shipping in refund calculation */
|
|
4867
|
-
refundShipping?: boolean;
|
|
5053
|
+
items?: RestockItem[];
|
|
4868
5054
|
}
|
|
4869
|
-
|
|
5055
|
+
declare enum RestockType {
|
|
5056
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5057
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5058
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5059
|
+
}
|
|
5060
|
+
/** @enumType */
|
|
5061
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5062
|
+
interface RestockItem {
|
|
4870
5063
|
/**
|
|
4871
|
-
* ID of the line item being
|
|
5064
|
+
* ID of the line item being restocked.
|
|
4872
5065
|
* @format GUID
|
|
4873
5066
|
*/
|
|
4874
|
-
|
|
5067
|
+
lineItemId?: string;
|
|
4875
5068
|
/**
|
|
4876
|
-
*
|
|
5069
|
+
* Line item quantity being restocked.
|
|
4877
5070
|
* @min 1
|
|
4878
5071
|
* @max 100000
|
|
4879
5072
|
*/
|
|
4880
5073
|
quantity?: number;
|
|
4881
5074
|
}
|
|
4882
|
-
interface
|
|
4883
|
-
/**
|
|
4884
|
-
|
|
4885
|
-
/**
|
|
4886
|
-
|
|
4887
|
-
/**
|
|
4888
|
-
|
|
4889
|
-
|
|
4890
|
-
|
|
4891
|
-
|
|
4892
|
-
|
|
4893
|
-
|
|
4894
|
-
|
|
5075
|
+
interface TriggerRefundResponse {
|
|
5076
|
+
/** All order's transactions after the refunds were added */
|
|
5077
|
+
orderTransactions?: OrderTransactions;
|
|
5078
|
+
/** Created refund ID */
|
|
5079
|
+
refundId?: string | null;
|
|
5080
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5081
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5082
|
+
}
|
|
5083
|
+
/**
|
|
5084
|
+
* A record of all payments and refunds associated with an order.
|
|
5085
|
+
*
|
|
5086
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5087
|
+
*/
|
|
5088
|
+
interface OrderTransactions {
|
|
4895
5089
|
/**
|
|
4896
|
-
*
|
|
5090
|
+
* Order ID.
|
|
5091
|
+
* @format GUID
|
|
5092
|
+
*/
|
|
5093
|
+
orderId?: string;
|
|
5094
|
+
/**
|
|
5095
|
+
* Record of payments made to the merchant.
|
|
5096
|
+
* @maxSize 100
|
|
5097
|
+
*/
|
|
5098
|
+
payments?: Payment[];
|
|
5099
|
+
/**
|
|
5100
|
+
* Record of refunds made to the buyer.
|
|
4897
5101
|
* @maxSize 300
|
|
4898
5102
|
*/
|
|
4899
|
-
|
|
5103
|
+
refunds?: Refund[];
|
|
4900
5104
|
}
|
|
4901
|
-
interface
|
|
5105
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
5106
|
+
/** Regular payment details. */
|
|
5107
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5108
|
+
/** Gift card payment details. */
|
|
5109
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
4902
5110
|
/**
|
|
4903
|
-
*
|
|
5111
|
+
* Payment ID.
|
|
4904
5112
|
* @format GUID
|
|
5113
|
+
* @readonly
|
|
4905
5114
|
*/
|
|
4906
|
-
_id?: string;
|
|
4907
|
-
/**
|
|
4908
|
-
|
|
5115
|
+
_id?: string | null;
|
|
5116
|
+
/** 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. */
|
|
5117
|
+
_createdDate?: Date | null;
|
|
5118
|
+
/**
|
|
5119
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5120
|
+
* @readonly
|
|
5121
|
+
*/
|
|
5122
|
+
_updatedDate?: Date | null;
|
|
5123
|
+
/** Payment amount. */
|
|
5124
|
+
amount?: Price;
|
|
5125
|
+
/**
|
|
5126
|
+
* Whether refunds for this payment are disabled.
|
|
5127
|
+
* + `true`: This payment is not refundable.
|
|
5128
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5129
|
+
*/
|
|
5130
|
+
refundDisabled?: boolean;
|
|
4909
5131
|
}
|
|
4910
|
-
|
|
5132
|
+
/** @oneof */
|
|
5133
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5134
|
+
/** Regular payment details. */
|
|
5135
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5136
|
+
/** Gift card payment details. */
|
|
5137
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5138
|
+
}
|
|
5139
|
+
/** @oneof */
|
|
5140
|
+
interface PaymentReceiptInfoOneOf {
|
|
5141
|
+
}
|
|
5142
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5143
|
+
/** Credit card details. */
|
|
5144
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4911
5145
|
/**
|
|
4912
|
-
* Wix
|
|
4913
|
-
* @minLength 1
|
|
5146
|
+
* Wix Payments order ID.
|
|
4914
5147
|
* @maxLength 100
|
|
4915
5148
|
*/
|
|
4916
|
-
|
|
5149
|
+
paymentOrderId?: string | null;
|
|
4917
5150
|
/**
|
|
4918
|
-
* Payment
|
|
4919
|
-
*
|
|
4920
|
-
* @
|
|
4921
|
-
* @format GUID
|
|
5151
|
+
* Payment gateway's transaction ID.
|
|
5152
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5153
|
+
* @maxLength 100
|
|
4922
5154
|
*/
|
|
4923
|
-
|
|
5155
|
+
gatewayTransactionId?: string | null;
|
|
5156
|
+
/**
|
|
5157
|
+
* Payment method.
|
|
5158
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5159
|
+
* Non-exhaustive list of supported values:
|
|
5160
|
+
* + `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`
|
|
5161
|
+
* @maxLength 100
|
|
5162
|
+
* @deprecated Payment method.
|
|
5163
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5164
|
+
* Non-exhaustive list of supported values:
|
|
5165
|
+
* + `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`
|
|
5166
|
+
* @replacedBy payment_method_name
|
|
5167
|
+
* @targetRemovalDate 2026-07-01
|
|
5168
|
+
*/
|
|
5169
|
+
paymentMethod?: string | null;
|
|
5170
|
+
/**
|
|
5171
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5172
|
+
* @maxLength 100
|
|
5173
|
+
*/
|
|
5174
|
+
providerTransactionId?: string | null;
|
|
5175
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5176
|
+
offlinePayment?: boolean;
|
|
5177
|
+
/** Payment status. */
|
|
5178
|
+
status?: TransactionStatusWithLiterals;
|
|
5179
|
+
/**
|
|
5180
|
+
* Whether there is a payment agreement that allows for future charges.
|
|
5181
|
+
* @immutable
|
|
5182
|
+
*/
|
|
5183
|
+
savedPaymentMethod?: boolean;
|
|
5184
|
+
/** Authorization details. */
|
|
5185
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5186
|
+
/**
|
|
5187
|
+
* Record of chargebacks made by the buyer.
|
|
5188
|
+
* @maxSize 6
|
|
5189
|
+
*/
|
|
5190
|
+
chargebacks?: Chargeback[];
|
|
5191
|
+
/** Platform fee amount associated with this payment. */
|
|
5192
|
+
platformFee?: Price;
|
|
5193
|
+
/**
|
|
5194
|
+
* Payment method with buyer and optional owner translations.
|
|
5195
|
+
* Non-exhaustive list of supported values:
|
|
5196
|
+
* + `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`
|
|
5197
|
+
*/
|
|
5198
|
+
paymentMethodName?: PaymentMethodName;
|
|
4924
5199
|
}
|
|
4925
|
-
|
|
4926
|
-
|
|
4927
|
-
|
|
5200
|
+
/** @oneof */
|
|
5201
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5202
|
+
/** Credit card details. */
|
|
5203
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
4928
5204
|
}
|
|
4929
|
-
|
|
5205
|
+
declare enum TransactionStatus {
|
|
5206
|
+
UNDEFINED = "UNDEFINED",
|
|
5207
|
+
APPROVED = "APPROVED",
|
|
5208
|
+
PENDING = "PENDING",
|
|
5209
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5210
|
+
CANCELED = "CANCELED",
|
|
5211
|
+
DECLINED = "DECLINED",
|
|
5212
|
+
REFUNDED = "REFUNDED",
|
|
5213
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5214
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5215
|
+
VOIDED = "VOIDED"
|
|
5216
|
+
}
|
|
5217
|
+
/** @enumType */
|
|
5218
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5219
|
+
interface CreditCardPaymentMethodDetails {
|
|
4930
5220
|
/**
|
|
4931
|
-
*
|
|
4932
|
-
* @
|
|
5221
|
+
* The last 4 digits of the card number.
|
|
5222
|
+
* @maxLength 4
|
|
5223
|
+
*/
|
|
5224
|
+
lastFourDigits?: string | null;
|
|
5225
|
+
/**
|
|
5226
|
+
* Card issuer's brand.
|
|
4933
5227
|
* @maxLength 100
|
|
4934
5228
|
*/
|
|
4935
|
-
|
|
5229
|
+
brand?: string | null;
|
|
5230
|
+
}
|
|
5231
|
+
interface AuthorizationDetails {
|
|
4936
5232
|
/**
|
|
4937
|
-
*
|
|
4938
|
-
* @
|
|
4939
|
-
* @maxSize 100
|
|
5233
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5234
|
+
* @readonly
|
|
4940
5235
|
*/
|
|
4941
|
-
|
|
5236
|
+
delayedCapture?: boolean;
|
|
5237
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5238
|
+
authorizedDate?: Date | null;
|
|
5239
|
+
/**
|
|
5240
|
+
* List of captures associated with payment
|
|
5241
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5242
|
+
* @maxSize 1
|
|
5243
|
+
*/
|
|
5244
|
+
captures?: AuthorizationCapture[];
|
|
5245
|
+
/** Void associated with payment */
|
|
5246
|
+
void?: AuthorizationVoid;
|
|
5247
|
+
/** Scheduled action for this transaction */
|
|
5248
|
+
scheduledAction?: V1ScheduledAction;
|
|
4942
5249
|
}
|
|
4943
|
-
interface
|
|
5250
|
+
interface AuthorizationCapture {
|
|
4944
5251
|
/**
|
|
4945
|
-
*
|
|
5252
|
+
* Capture ID.
|
|
4946
5253
|
* @format GUID
|
|
5254
|
+
* @readonly
|
|
4947
5255
|
*/
|
|
4948
|
-
|
|
4949
|
-
/**
|
|
4950
|
-
|
|
4951
|
-
* If not provided - full authorized amount will be captured.
|
|
4952
|
-
*/
|
|
4953
|
-
amount?: Price;
|
|
4954
|
-
}
|
|
4955
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
4956
|
-
/** All order's transactions after the capture was triggered */
|
|
4957
|
-
orderTransactions?: OrderTransactions;
|
|
4958
|
-
}
|
|
4959
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
5256
|
+
_id?: string | null;
|
|
5257
|
+
/** Status of this capture action */
|
|
5258
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
4960
5259
|
/**
|
|
4961
|
-
*
|
|
4962
|
-
* @
|
|
4963
|
-
* @maxLength 100
|
|
5260
|
+
* Amount of this capture
|
|
5261
|
+
* @immutable
|
|
4964
5262
|
*/
|
|
4965
|
-
ecomOrderId?: string;
|
|
4966
|
-
/** Amount to be charged */
|
|
4967
5263
|
amount?: Price;
|
|
5264
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5265
|
+
_createdDate?: Date | null;
|
|
5266
|
+
/** In case of status is FAILED may contain failure details */
|
|
5267
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
4968
5268
|
}
|
|
4969
|
-
|
|
4970
|
-
/**
|
|
4971
|
-
|
|
5269
|
+
declare enum AuthorizationCaptureStatus {
|
|
5270
|
+
/** Capture operation still in progress. */
|
|
5271
|
+
PENDING = "PENDING",
|
|
5272
|
+
/** Capture operation succeeded. */
|
|
5273
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5274
|
+
/** Capture operation failed. */
|
|
5275
|
+
FAILED = "FAILED"
|
|
4972
5276
|
}
|
|
4973
|
-
|
|
4974
|
-
|
|
4975
|
-
|
|
5277
|
+
/** @enumType */
|
|
5278
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5279
|
+
interface AuthorizationActionFailureDetails {
|
|
5280
|
+
/** @maxLength 100 */
|
|
5281
|
+
failureCode?: string;
|
|
4976
5282
|
}
|
|
4977
|
-
interface
|
|
5283
|
+
interface AuthorizationVoid {
|
|
5284
|
+
/** Status of this void action */
|
|
5285
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5286
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5287
|
+
voidedDate?: Date | null;
|
|
5288
|
+
/** In case of status is FAILED may contain failure details */
|
|
5289
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5290
|
+
/** Reason of void action */
|
|
5291
|
+
reason?: ReasonWithLiterals;
|
|
4978
5292
|
}
|
|
4979
|
-
|
|
4980
|
-
/**
|
|
4981
|
-
|
|
4982
|
-
|
|
4983
|
-
|
|
4984
|
-
|
|
5293
|
+
declare enum AuthorizationVoidStatus {
|
|
5294
|
+
/** Void operation still in progress. */
|
|
5295
|
+
PENDING = "PENDING",
|
|
5296
|
+
/** Void operation succeeded. */
|
|
5297
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5298
|
+
/** Void operation failed. */
|
|
5299
|
+
FAILED = "FAILED"
|
|
4985
5300
|
}
|
|
4986
|
-
|
|
5301
|
+
/** @enumType */
|
|
5302
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5303
|
+
/** Reason the authorization was voided. */
|
|
5304
|
+
declare enum Reason {
|
|
5305
|
+
/** Authorization was voided by user. */
|
|
5306
|
+
MANUAL = "MANUAL",
|
|
5307
|
+
/** Authorization passed execution date. */
|
|
5308
|
+
SCHEDULED = "SCHEDULED"
|
|
4987
5309
|
}
|
|
4988
|
-
|
|
4989
|
-
|
|
4990
|
-
|
|
4991
|
-
|
|
4992
|
-
|
|
4993
|
-
|
|
5310
|
+
/** @enumType */
|
|
5311
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5312
|
+
interface V1ScheduledAction {
|
|
5313
|
+
/** Type of the action. */
|
|
5314
|
+
actionType?: ActionTypeWithLiterals;
|
|
5315
|
+
/** The date and time of the action. */
|
|
5316
|
+
executionDate?: Date | null;
|
|
4994
5317
|
}
|
|
4995
|
-
|
|
5318
|
+
declare enum ActionType {
|
|
5319
|
+
VOID = "VOID",
|
|
5320
|
+
CAPTURE = "CAPTURE"
|
|
4996
5321
|
}
|
|
4997
|
-
|
|
5322
|
+
/** @enumType */
|
|
5323
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5324
|
+
interface Chargeback {
|
|
4998
5325
|
/**
|
|
4999
|
-
*
|
|
5000
|
-
* @
|
|
5001
|
-
* @
|
|
5326
|
+
* Chargeback ID.
|
|
5327
|
+
* @format GUID
|
|
5328
|
+
* @readonly
|
|
5329
|
+
* @immutable
|
|
5002
5330
|
*/
|
|
5003
|
-
|
|
5004
|
-
}
|
|
5005
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
5006
|
-
}
|
|
5007
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
5331
|
+
_id?: string;
|
|
5008
5332
|
/**
|
|
5009
|
-
*
|
|
5010
|
-
* @
|
|
5333
|
+
* 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.
|
|
5334
|
+
* @readonly
|
|
5335
|
+
* @immutable
|
|
5011
5336
|
*/
|
|
5012
|
-
|
|
5013
|
-
}
|
|
5014
|
-
interface SendBuyerShippingConfirmationEmailResponse {
|
|
5015
|
-
}
|
|
5016
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
5337
|
+
_createdDate?: Date | null;
|
|
5017
5338
|
/**
|
|
5018
|
-
*
|
|
5019
|
-
* @
|
|
5020
|
-
* @maxSize 300
|
|
5339
|
+
* 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.
|
|
5340
|
+
* @readonly
|
|
5021
5341
|
*/
|
|
5022
|
-
|
|
5023
|
-
}
|
|
5024
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
5025
|
-
}
|
|
5026
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
5342
|
+
_updatedDate?: Date | null;
|
|
5027
5343
|
/**
|
|
5028
|
-
*
|
|
5029
|
-
* @
|
|
5344
|
+
* Amount.
|
|
5345
|
+
* @readonly
|
|
5346
|
+
* @immutable
|
|
5030
5347
|
*/
|
|
5031
|
-
|
|
5032
|
-
}
|
|
5033
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
5034
|
-
}
|
|
5035
|
-
interface SendCancelRefundEmailRequest {
|
|
5348
|
+
amount?: Price;
|
|
5036
5349
|
/**
|
|
5037
|
-
*
|
|
5038
|
-
* @
|
|
5039
|
-
* @maxLength 100
|
|
5350
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5351
|
+
* @readonly
|
|
5040
5352
|
*/
|
|
5041
|
-
|
|
5353
|
+
reversalAmount?: Price;
|
|
5042
5354
|
/**
|
|
5043
|
-
*
|
|
5044
|
-
*
|
|
5045
|
-
*
|
|
5355
|
+
* Status.
|
|
5356
|
+
*
|
|
5357
|
+
* Default: `"APPROVED"`.
|
|
5046
5358
|
*/
|
|
5047
|
-
|
|
5048
|
-
/** Refund amount */
|
|
5049
|
-
refundAmount?: Price;
|
|
5359
|
+
status?: ChargebackStatusWithLiterals;
|
|
5050
5360
|
/**
|
|
5051
|
-
*
|
|
5361
|
+
* External chargeback ID.
|
|
5052
5362
|
* @format GUID
|
|
5363
|
+
* @readonly
|
|
5364
|
+
* @immutable
|
|
5053
5365
|
*/
|
|
5054
|
-
|
|
5366
|
+
externalId?: string | null;
|
|
5055
5367
|
}
|
|
5056
|
-
|
|
5368
|
+
declare enum ChargebackStatus {
|
|
5369
|
+
/** Chargeback was approved. */
|
|
5370
|
+
APPROVED = "APPROVED",
|
|
5371
|
+
/** Chargeback was reversed. */
|
|
5372
|
+
REVERSED = "REVERSED"
|
|
5057
5373
|
}
|
|
5058
|
-
|
|
5059
|
-
|
|
5060
|
-
|
|
5061
|
-
* @format GUID
|
|
5062
|
-
*/
|
|
5063
|
-
orderId?: string;
|
|
5374
|
+
/** @enumType */
|
|
5375
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5376
|
+
interface PaymentMethodName {
|
|
5064
5377
|
/**
|
|
5065
|
-
*
|
|
5066
|
-
* @
|
|
5378
|
+
* Translated payment method name in buyer language.
|
|
5379
|
+
* @maxLength 100
|
|
5067
5380
|
*/
|
|
5068
|
-
|
|
5381
|
+
buyerLanguageName?: string | null;
|
|
5069
5382
|
/**
|
|
5070
|
-
*
|
|
5071
|
-
* @
|
|
5072
|
-
* @maxLength 1000
|
|
5383
|
+
* Translated payment method name in site owner language.
|
|
5384
|
+
* @maxLength 100
|
|
5073
5385
|
*/
|
|
5074
|
-
|
|
5075
|
-
}
|
|
5076
|
-
interface SendRefundEmailResponse {
|
|
5077
|
-
}
|
|
5078
|
-
interface SendFulfillmentEmailRequest {
|
|
5079
|
-
/** @format GUID */
|
|
5080
|
-
orderId?: string;
|
|
5081
|
-
/** @format GUID */
|
|
5082
|
-
fulfillerId?: string;
|
|
5083
|
-
}
|
|
5084
|
-
interface SendFulfillmentEmailResponse {
|
|
5085
|
-
}
|
|
5086
|
-
interface SendMerchantOrderReceivedPushRequest {
|
|
5386
|
+
siteLanguageName?: string | null;
|
|
5087
5387
|
/**
|
|
5088
|
-
*
|
|
5089
|
-
*
|
|
5388
|
+
* User-provided payment method name.
|
|
5389
|
+
*
|
|
5390
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5090
5391
|
*/
|
|
5091
|
-
|
|
5092
|
-
}
|
|
5093
|
-
interface SendMerchantOrderReceivedPushResponse {
|
|
5094
|
-
}
|
|
5095
|
-
interface PreviewEmailByTypeRequest {
|
|
5096
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
5097
|
-
}
|
|
5098
|
-
declare enum PreviewEmailType {
|
|
5099
|
-
ORDER_PLACED = "ORDER_PLACED",
|
|
5100
|
-
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
5101
|
-
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
5102
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
5103
|
-
}
|
|
5104
|
-
/** @enumType */
|
|
5105
|
-
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
5106
|
-
interface PreviewEmailByTypeResponse {
|
|
5107
|
-
emailPreview?: string;
|
|
5392
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
5108
5393
|
}
|
|
5109
|
-
interface
|
|
5394
|
+
interface GiftCardPaymentDetails {
|
|
5110
5395
|
/**
|
|
5111
|
-
*
|
|
5396
|
+
* Gift card payment ID.
|
|
5112
5397
|
* @maxLength 100
|
|
5113
5398
|
*/
|
|
5114
|
-
|
|
5115
|
-
/** Refund amount */
|
|
5116
|
-
refundAmount?: Price;
|
|
5117
|
-
/** Refund business details */
|
|
5118
|
-
details?: RefundDetails;
|
|
5399
|
+
giftCardPaymentId?: string;
|
|
5119
5400
|
/**
|
|
5120
|
-
*
|
|
5121
|
-
* @
|
|
5122
|
-
* @maxLength 1000
|
|
5401
|
+
* ID of the app that created the gift card.
|
|
5402
|
+
* @format GUID
|
|
5123
5403
|
*/
|
|
5124
|
-
|
|
5404
|
+
appId?: string;
|
|
5125
5405
|
/**
|
|
5126
|
-
*
|
|
5127
|
-
* @
|
|
5406
|
+
* Whether the gift card is voided.
|
|
5407
|
+
* @readonly
|
|
5128
5408
|
*/
|
|
5129
|
-
|
|
5130
|
-
}
|
|
5131
|
-
interface PreviewRefundEmailResponse {
|
|
5132
|
-
emailPreview?: string;
|
|
5409
|
+
voided?: boolean;
|
|
5133
5410
|
}
|
|
5134
|
-
interface
|
|
5411
|
+
interface MembershipPaymentDetails {
|
|
5135
5412
|
/**
|
|
5413
|
+
* Membership ID.
|
|
5136
5414
|
* @minLength 1
|
|
5137
5415
|
* @maxLength 100
|
|
5138
5416
|
*/
|
|
5139
|
-
|
|
5417
|
+
membershipId?: string;
|
|
5140
5418
|
/**
|
|
5141
|
-
*
|
|
5419
|
+
* ID of the line item this membership applies to.
|
|
5142
5420
|
* @minLength 1
|
|
5143
|
-
* @maxLength
|
|
5421
|
+
* @maxLength 100
|
|
5144
5422
|
*/
|
|
5145
|
-
|
|
5146
|
-
|
|
5147
|
-
|
|
5148
|
-
|
|
5149
|
-
|
|
5150
|
-
interface PreviewCancelRefundEmailRequest {
|
|
5423
|
+
lineItemId?: string;
|
|
5424
|
+
/** Payment status. */
|
|
5425
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5426
|
+
/** Membership name. */
|
|
5427
|
+
name?: MembershipName;
|
|
5151
5428
|
/**
|
|
5429
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
5152
5430
|
* @minLength 1
|
|
5153
5431
|
* @maxLength 100
|
|
5154
5432
|
*/
|
|
5155
|
-
|
|
5433
|
+
externalTransactionId?: string | null;
|
|
5156
5434
|
/**
|
|
5157
|
-
*
|
|
5158
|
-
* @
|
|
5159
|
-
* @maxLength 1000
|
|
5435
|
+
* Whether the membership is voided.
|
|
5436
|
+
* @readonly
|
|
5160
5437
|
*/
|
|
5161
|
-
|
|
5162
|
-
/** Refund amount */
|
|
5163
|
-
refundAmount?: Price;
|
|
5438
|
+
voided?: boolean;
|
|
5164
5439
|
/**
|
|
5165
|
-
*
|
|
5440
|
+
* ID of the application providing this payment option.
|
|
5166
5441
|
* @format GUID
|
|
5167
5442
|
*/
|
|
5168
|
-
|
|
5169
|
-
}
|
|
5170
|
-
interface PreviewCancelRefundEmailResponse {
|
|
5171
|
-
emailPreview?: string;
|
|
5172
|
-
}
|
|
5173
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
5174
|
-
}
|
|
5175
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5176
|
-
emailPreview?: string;
|
|
5177
|
-
}
|
|
5178
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
5179
|
-
}
|
|
5180
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
5181
|
-
emailPreview?: string;
|
|
5182
|
-
}
|
|
5183
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
5184
|
-
}
|
|
5185
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
5186
|
-
emailPreview?: string;
|
|
5187
|
-
}
|
|
5188
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
5189
|
-
}
|
|
5190
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
5191
|
-
emailPreview?: string;
|
|
5192
|
-
}
|
|
5193
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
5443
|
+
providerAppId?: string;
|
|
5194
5444
|
}
|
|
5195
|
-
|
|
5196
|
-
|
|
5445
|
+
declare enum MembershipPaymentStatus {
|
|
5446
|
+
/** Payment was charged. */
|
|
5447
|
+
CHARGED = "CHARGED",
|
|
5448
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5449
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5450
|
+
/** Payment is pending. */
|
|
5451
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5452
|
+
/** Payment was voided. */
|
|
5453
|
+
VOIDED = "VOIDED"
|
|
5197
5454
|
}
|
|
5198
|
-
|
|
5199
|
-
|
|
5200
|
-
|
|
5201
|
-
/** Emitted on a meta site transfer completion. */
|
|
5202
|
-
siteTransferred?: SiteTransferred;
|
|
5203
|
-
/** Emitted on a meta site deletion. */
|
|
5204
|
-
siteDeleted?: SiteDeleted;
|
|
5205
|
-
/** Emitted on a meta site restoration. */
|
|
5206
|
-
siteUndeleted?: SiteUndeleted;
|
|
5207
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5208
|
-
sitePublished?: SitePublished;
|
|
5209
|
-
/** Emitted on a meta site unpublish. */
|
|
5210
|
-
siteUnpublished?: SiteUnpublished;
|
|
5211
|
-
/** Emitted when meta site is marked as template. */
|
|
5212
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5213
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5214
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5215
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5216
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5217
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5218
|
-
serviceRemoved?: ServiceRemoved;
|
|
5219
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5220
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5221
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5222
|
-
hardDeleted?: SiteHardDeleted;
|
|
5223
|
-
/** Emitted on a namespace change. */
|
|
5224
|
-
namespaceChanged?: NamespaceChanged;
|
|
5225
|
-
/** Emitted when Studio is attached. */
|
|
5226
|
-
studioAssigned?: StudioAssigned;
|
|
5227
|
-
/** Emitted when Studio is detached. */
|
|
5228
|
-
studioUnassigned?: StudioUnassigned;
|
|
5229
|
-
/**
|
|
5230
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5231
|
-
* the actual URL.
|
|
5232
|
-
*
|
|
5233
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5234
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5235
|
-
*/
|
|
5236
|
-
urlChanged?: SiteUrlChanged;
|
|
5237
|
-
/** Site is marked as PurgedExternally */
|
|
5238
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5239
|
-
/** Emitted when Odeditor is attached. */
|
|
5240
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5241
|
-
/** Emitted when Odeditor is detached. */
|
|
5242
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5243
|
-
/** Emitted when Picasso is attached. */
|
|
5244
|
-
picassoAssigned?: PicassoAssigned;
|
|
5245
|
-
/** Emitted when Picasso is detached. */
|
|
5246
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5247
|
-
/** Emitted when Wixel is attached. */
|
|
5248
|
-
wixelAssigned?: WixelAssigned;
|
|
5249
|
-
/** Emitted when Wixel is detached. */
|
|
5250
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5251
|
-
/** Emitted when StudioTwo is attached. */
|
|
5252
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5253
|
-
/** Emitted when StudioTwo is detached. */
|
|
5254
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5255
|
-
/** Emitted when media from user domain is enabled. */
|
|
5256
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5257
|
-
/** Emitted when media from user domain is disabled. */
|
|
5258
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5259
|
-
/** Emitted when Editorless is attached. */
|
|
5260
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5261
|
-
/** Emitted when Editorless is detached. */
|
|
5262
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5455
|
+
/** @enumType */
|
|
5456
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5457
|
+
interface WixReceiptInfo {
|
|
5263
5458
|
/**
|
|
5264
|
-
*
|
|
5459
|
+
* Receipt ID
|
|
5265
5460
|
* @format GUID
|
|
5266
5461
|
*/
|
|
5267
|
-
|
|
5268
|
-
/** A meta site version. Monotonically increasing. */
|
|
5269
|
-
version?: string;
|
|
5270
|
-
/** A timestamp of the event. */
|
|
5271
|
-
timestamp?: string;
|
|
5272
|
-
/**
|
|
5273
|
-
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
5274
|
-
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
5275
|
-
* @maxSize 4000
|
|
5276
|
-
*/
|
|
5277
|
-
assets?: Asset[];
|
|
5278
|
-
}
|
|
5279
|
-
/** @oneof */
|
|
5280
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5281
|
-
/** Emitted on a meta site creation. */
|
|
5282
|
-
siteCreated?: SiteCreated;
|
|
5283
|
-
/** Emitted on a meta site transfer completion. */
|
|
5284
|
-
siteTransferred?: SiteTransferred;
|
|
5285
|
-
/** Emitted on a meta site deletion. */
|
|
5286
|
-
siteDeleted?: SiteDeleted;
|
|
5287
|
-
/** Emitted on a meta site restoration. */
|
|
5288
|
-
siteUndeleted?: SiteUndeleted;
|
|
5289
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5290
|
-
sitePublished?: SitePublished;
|
|
5291
|
-
/** Emitted on a meta site unpublish. */
|
|
5292
|
-
siteUnpublished?: SiteUnpublished;
|
|
5293
|
-
/** Emitted when meta site is marked as template. */
|
|
5294
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5295
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5296
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5297
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5298
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5299
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5300
|
-
serviceRemoved?: ServiceRemoved;
|
|
5301
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5302
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5303
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5304
|
-
hardDeleted?: SiteHardDeleted;
|
|
5305
|
-
/** Emitted on a namespace change. */
|
|
5306
|
-
namespaceChanged?: NamespaceChanged;
|
|
5307
|
-
/** Emitted when Studio is attached. */
|
|
5308
|
-
studioAssigned?: StudioAssigned;
|
|
5309
|
-
/** Emitted when Studio is detached. */
|
|
5310
|
-
studioUnassigned?: StudioUnassigned;
|
|
5311
|
-
/**
|
|
5312
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5313
|
-
* the actual URL.
|
|
5314
|
-
*
|
|
5315
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5316
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5317
|
-
*/
|
|
5318
|
-
urlChanged?: SiteUrlChanged;
|
|
5319
|
-
/** Site is marked as PurgedExternally */
|
|
5320
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5321
|
-
/** Emitted when Odeditor is attached. */
|
|
5322
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5323
|
-
/** Emitted when Odeditor is detached. */
|
|
5324
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5325
|
-
/** Emitted when Picasso is attached. */
|
|
5326
|
-
picassoAssigned?: PicassoAssigned;
|
|
5327
|
-
/** Emitted when Picasso is detached. */
|
|
5328
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5329
|
-
/** Emitted when Wixel is attached. */
|
|
5330
|
-
wixelAssigned?: WixelAssigned;
|
|
5331
|
-
/** Emitted when Wixel is detached. */
|
|
5332
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5333
|
-
/** Emitted when StudioTwo is attached. */
|
|
5334
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5335
|
-
/** Emitted when StudioTwo is detached. */
|
|
5336
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5337
|
-
/** Emitted when media from user domain is enabled. */
|
|
5338
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5339
|
-
/** Emitted when media from user domain is disabled. */
|
|
5340
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5341
|
-
/** Emitted when Editorless is attached. */
|
|
5342
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5343
|
-
/** Emitted when Editorless is detached. */
|
|
5344
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5345
|
-
}
|
|
5346
|
-
interface Asset {
|
|
5347
|
-
/**
|
|
5348
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
5349
|
-
* @maxLength 36
|
|
5350
|
-
*/
|
|
5351
|
-
appDefId?: string;
|
|
5352
|
-
/**
|
|
5353
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
5354
|
-
* @maxLength 200
|
|
5355
|
-
*/
|
|
5356
|
-
instanceId?: string;
|
|
5357
|
-
/** An application state. */
|
|
5358
|
-
state?: StateWithLiterals;
|
|
5359
|
-
}
|
|
5360
|
-
declare enum State {
|
|
5361
|
-
UNKNOWN = "UNKNOWN",
|
|
5362
|
-
ENABLED = "ENABLED",
|
|
5363
|
-
DISABLED = "DISABLED",
|
|
5364
|
-
PENDING = "PENDING",
|
|
5365
|
-
DEMO = "DEMO"
|
|
5366
|
-
}
|
|
5367
|
-
/** @enumType */
|
|
5368
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5369
|
-
interface SiteCreated {
|
|
5462
|
+
receiptId?: string;
|
|
5370
5463
|
/**
|
|
5371
|
-
*
|
|
5372
|
-
* @
|
|
5464
|
+
* Display number of receipt
|
|
5465
|
+
* @minLength 1
|
|
5466
|
+
* @maxLength 40
|
|
5373
5467
|
*/
|
|
5374
|
-
|
|
5468
|
+
displayNumber?: string | null;
|
|
5469
|
+
}
|
|
5470
|
+
interface ExternalReceiptInfo {
|
|
5375
5471
|
/**
|
|
5376
|
-
*
|
|
5377
|
-
* @
|
|
5472
|
+
* External receipt ID
|
|
5473
|
+
* @maxLength 100
|
|
5378
5474
|
*/
|
|
5379
|
-
|
|
5380
|
-
/** A context in which meta site was created. */
|
|
5381
|
-
context?: SiteCreatedContextWithLiterals;
|
|
5475
|
+
receiptId?: string | null;
|
|
5382
5476
|
/**
|
|
5383
|
-
*
|
|
5384
|
-
*
|
|
5385
|
-
* In case of a creation from a template it's a template id.
|
|
5386
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5477
|
+
* ID of the app providing the receipt
|
|
5387
5478
|
* @format GUID
|
|
5388
5479
|
*/
|
|
5389
|
-
|
|
5480
|
+
appId?: string | null;
|
|
5390
5481
|
/**
|
|
5391
|
-
*
|
|
5392
|
-
* @
|
|
5482
|
+
* Display number of receipt
|
|
5483
|
+
* @minLength 1
|
|
5484
|
+
* @maxLength 40
|
|
5393
5485
|
*/
|
|
5394
|
-
|
|
5395
|
-
/** A namespace. */
|
|
5396
|
-
namespace?: NamespaceWithLiterals;
|
|
5486
|
+
displayNumber?: string | null;
|
|
5397
5487
|
}
|
|
5398
|
-
|
|
5399
|
-
|
|
5400
|
-
|
|
5401
|
-
|
|
5402
|
-
|
|
5403
|
-
|
|
5404
|
-
|
|
5405
|
-
|
|
5406
|
-
|
|
5407
|
-
|
|
5408
|
-
|
|
5409
|
-
|
|
5410
|
-
FLASH = "FLASH"
|
|
5488
|
+
interface CashRoundingDetails {
|
|
5489
|
+
}
|
|
5490
|
+
declare enum PaymentStatus {
|
|
5491
|
+
APPROVED = "APPROVED",
|
|
5492
|
+
PENDING = "PENDING",
|
|
5493
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5494
|
+
CANCELED = "CANCELED",
|
|
5495
|
+
DECLINED = "DECLINED",
|
|
5496
|
+
REFUNDED = "REFUNDED",
|
|
5497
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5498
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5499
|
+
VOIDED = "VOIDED"
|
|
5411
5500
|
}
|
|
5412
5501
|
/** @enumType */
|
|
5413
|
-
type
|
|
5414
|
-
|
|
5415
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5416
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5417
|
-
WIX = "WIX",
|
|
5418
|
-
/** 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. */
|
|
5419
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
5420
|
-
/** 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. */
|
|
5421
|
-
ALBUMS = "ALBUMS",
|
|
5422
|
-
/** 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. */
|
|
5423
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5424
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5425
|
-
HOTELS = "HOTELS",
|
|
5426
|
-
/** 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. */
|
|
5427
|
-
CLUBS = "CLUBS",
|
|
5428
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5429
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5430
|
-
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5431
|
-
DEV_SITE = "DEV_SITE",
|
|
5432
|
-
/** 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. */
|
|
5433
|
-
LOGOS = "LOGOS",
|
|
5434
|
-
/** 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. */
|
|
5435
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5436
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5437
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5438
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5439
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5440
|
-
/**
|
|
5441
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5442
|
-
*
|
|
5443
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5444
|
-
*/
|
|
5445
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
5502
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5503
|
+
interface Refund {
|
|
5446
5504
|
/**
|
|
5447
|
-
*
|
|
5448
|
-
*
|
|
5449
|
-
*
|
|
5505
|
+
* Refund ID.
|
|
5506
|
+
* @format GUID
|
|
5507
|
+
* @readonly
|
|
5450
5508
|
*/
|
|
5451
|
-
|
|
5452
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5453
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5454
|
-
/** It is to be used in the Business First efforts. */
|
|
5455
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5456
|
-
/** Bookings business flow with no site. */
|
|
5457
|
-
ANYWHERE = "ANYWHERE",
|
|
5458
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
5459
|
-
HEADLESS = "HEADLESS",
|
|
5509
|
+
_id?: string;
|
|
5460
5510
|
/**
|
|
5461
|
-
*
|
|
5462
|
-
*
|
|
5511
|
+
* List of transactions.
|
|
5512
|
+
* @maxSize 50
|
|
5463
5513
|
*/
|
|
5464
|
-
|
|
5465
|
-
/**
|
|
5466
|
-
|
|
5514
|
+
transactions?: RefundTransaction[];
|
|
5515
|
+
/** Refund business details. */
|
|
5516
|
+
details?: RefundDetails;
|
|
5467
5517
|
/**
|
|
5468
|
-
*
|
|
5469
|
-
*
|
|
5470
|
-
*
|
|
5518
|
+
* 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.
|
|
5519
|
+
* @readonly
|
|
5520
|
+
* @immutable
|
|
5471
5521
|
*/
|
|
5472
|
-
|
|
5473
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5474
|
-
NOWNIA = "NOWNIA",
|
|
5522
|
+
_createdDate?: Date | null;
|
|
5475
5523
|
/**
|
|
5476
|
-
*
|
|
5477
|
-
*
|
|
5524
|
+
* Aggregated refund summary.
|
|
5525
|
+
* @readonly
|
|
5478
5526
|
*/
|
|
5479
|
-
|
|
5480
|
-
/** Codux Headless Sites */
|
|
5481
|
-
CODUX = "CODUX",
|
|
5482
|
-
/** Bobb - AI Design Creator. */
|
|
5483
|
-
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
5527
|
+
summary?: AggregatedRefundSummary;
|
|
5484
5528
|
/**
|
|
5485
|
-
*
|
|
5486
|
-
*
|
|
5529
|
+
* ID of the app that initiated this refund.
|
|
5530
|
+
* @format GUID
|
|
5531
|
+
* @readonly
|
|
5532
|
+
* @immutable
|
|
5487
5533
|
*/
|
|
5488
|
-
|
|
5489
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5490
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5491
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5492
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5493
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5494
|
-
MIMIR = "MIMIR",
|
|
5495
|
-
/** Wix Twins platform. */
|
|
5496
|
-
TWINS = "TWINS",
|
|
5497
|
-
/** Wix Nano. */
|
|
5498
|
-
NANO = "NANO",
|
|
5499
|
-
/** Base44 headless sites. */
|
|
5500
|
-
BASE44 = "BASE44",
|
|
5501
|
-
/** Wix Channels Sites */
|
|
5502
|
-
CHANNELS = "CHANNELS",
|
|
5503
|
-
/** Nautilus platform. */
|
|
5504
|
-
NAUTILUS = "NAUTILUS"
|
|
5534
|
+
requestingServiceAppId?: string | null;
|
|
5505
5535
|
}
|
|
5506
|
-
|
|
5507
|
-
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';
|
|
5508
|
-
/** Site transferred to another user. */
|
|
5509
|
-
interface SiteTransferred {
|
|
5536
|
+
interface RefundTransaction {
|
|
5510
5537
|
/**
|
|
5511
|
-
*
|
|
5538
|
+
* ID of the payment associated with this refund.
|
|
5512
5539
|
* @format GUID
|
|
5540
|
+
* @immutable
|
|
5513
5541
|
*/
|
|
5514
|
-
|
|
5542
|
+
paymentId?: string;
|
|
5515
5543
|
/**
|
|
5516
|
-
*
|
|
5517
|
-
* @
|
|
5544
|
+
* Refund amount.
|
|
5545
|
+
* @immutable
|
|
5518
5546
|
*/
|
|
5519
|
-
|
|
5520
|
-
|
|
5521
|
-
|
|
5522
|
-
|
|
5523
|
-
|
|
5524
|
-
deleteContext?: DeleteContext;
|
|
5525
|
-
}
|
|
5526
|
-
interface DeleteContext {
|
|
5527
|
-
/** When the meta site was deleted. */
|
|
5528
|
-
dateDeleted?: Date | null;
|
|
5529
|
-
/** A status. */
|
|
5530
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
5547
|
+
amount?: Price;
|
|
5548
|
+
/** Refund status. */
|
|
5549
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
5550
|
+
/** Optional details of current refund status. */
|
|
5551
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
5531
5552
|
/**
|
|
5532
|
-
*
|
|
5533
|
-
*
|
|
5553
|
+
* Payment gateway's refund ID.
|
|
5554
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
5555
|
+
* @format GUID
|
|
5534
5556
|
*/
|
|
5535
|
-
|
|
5557
|
+
gatewayRefundId?: string | null;
|
|
5558
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
5559
|
+
providerRefundId?: string | null;
|
|
5536
5560
|
/**
|
|
5537
|
-
*
|
|
5538
|
-
* @
|
|
5561
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
5562
|
+
* @immutable
|
|
5539
5563
|
*/
|
|
5540
|
-
|
|
5564
|
+
externalRefund?: boolean;
|
|
5541
5565
|
}
|
|
5542
|
-
|
|
5543
|
-
|
|
5544
|
-
|
|
5545
|
-
|
|
5546
|
-
|
|
5547
|
-
|
|
5566
|
+
/** Refund transaction status. */
|
|
5567
|
+
declare enum RefundStatus {
|
|
5568
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
5569
|
+
PENDING = "PENDING",
|
|
5570
|
+
/** Refund transaction succeeded. */
|
|
5571
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5572
|
+
/** Refund transaction failed. */
|
|
5573
|
+
FAILED = "FAILED",
|
|
5574
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
5575
|
+
SCHEDULED = "SCHEDULED",
|
|
5576
|
+
/** Refund was initiated on payment provider side. */
|
|
5577
|
+
STARTED = "STARTED"
|
|
5548
5578
|
}
|
|
5549
5579
|
/** @enumType */
|
|
5550
|
-
type
|
|
5551
|
-
|
|
5552
|
-
interface SiteUndeleted {
|
|
5553
|
-
}
|
|
5554
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5555
|
-
interface SitePublished {
|
|
5556
|
-
}
|
|
5557
|
-
interface SiteUnpublished {
|
|
5580
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
5581
|
+
interface RefundStatusInfo {
|
|
5558
5582
|
/**
|
|
5559
|
-
*
|
|
5560
|
-
*
|
|
5561
|
-
*
|
|
5583
|
+
* Reason code for the refund's current status.
|
|
5584
|
+
*
|
|
5585
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
5586
|
+
* @minLength 1
|
|
5587
|
+
* @maxLength 10
|
|
5562
5588
|
*/
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
|
|
5589
|
+
paymentGatewayReasonCode?: string | null;
|
|
5590
|
+
/**
|
|
5591
|
+
* Free text explanation of current refund status.
|
|
5592
|
+
* @minLength 1
|
|
5593
|
+
* @maxLength 1000
|
|
5594
|
+
*/
|
|
5595
|
+
description?: string | null;
|
|
5566
5596
|
}
|
|
5567
|
-
interface
|
|
5597
|
+
interface AggregatedRefundSummary {
|
|
5598
|
+
/** Total amount requested for refund. */
|
|
5599
|
+
requestedRefund?: Price;
|
|
5600
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
5601
|
+
pendingRefund?: Price;
|
|
5602
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
5603
|
+
refunded?: Price;
|
|
5604
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
5605
|
+
failedRefundAmount?: Price;
|
|
5606
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
5607
|
+
pending?: boolean;
|
|
5608
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
5609
|
+
breakdown?: RefundItemsBreakdown;
|
|
5568
5610
|
}
|
|
5569
|
-
|
|
5570
|
-
* Represents a service provisioned a site.
|
|
5571
|
-
*
|
|
5572
|
-
* Note on `origin_instance_id`:
|
|
5573
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5574
|
-
* This is because of the following scenario:
|
|
5575
|
-
*
|
|
5576
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5577
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5578
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
5579
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5580
|
-
* your site remains consistent with what you initially received and does not include any
|
|
5581
|
-
* changes made to the original template afterward.
|
|
5582
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5583
|
-
*/
|
|
5584
|
-
interface ServiceProvisioned {
|
|
5611
|
+
interface RefundItemsBreakdown {
|
|
5585
5612
|
/**
|
|
5586
|
-
*
|
|
5587
|
-
* @
|
|
5613
|
+
* Refunded line items and the amount refunded for each.
|
|
5614
|
+
* @maxSize 300
|
|
5588
5615
|
*/
|
|
5589
|
-
|
|
5616
|
+
lineItems?: LineItemRefundSummary[];
|
|
5617
|
+
}
|
|
5618
|
+
interface LineItemRefundSummary {
|
|
5590
5619
|
/**
|
|
5591
|
-
*
|
|
5592
|
-
* @
|
|
5620
|
+
* ID of the refunded line item.
|
|
5621
|
+
* @format GUID
|
|
5593
5622
|
*/
|
|
5594
|
-
|
|
5623
|
+
lineItemId?: string;
|
|
5624
|
+
/** Total refunded amount for the line item. */
|
|
5625
|
+
totalRefundedAmount?: Price;
|
|
5626
|
+
}
|
|
5627
|
+
interface CalculateRefundRequest {
|
|
5595
5628
|
/**
|
|
5596
|
-
*
|
|
5597
|
-
* @
|
|
5629
|
+
* Order ID
|
|
5630
|
+
* @minLength 1
|
|
5631
|
+
* @maxLength 100
|
|
5598
5632
|
*/
|
|
5599
|
-
|
|
5633
|
+
ecomOrderId?: string;
|
|
5600
5634
|
/**
|
|
5601
|
-
*
|
|
5602
|
-
* @
|
|
5635
|
+
* Refunded line items and quantity
|
|
5636
|
+
* @maxSize 300
|
|
5603
5637
|
*/
|
|
5604
|
-
|
|
5638
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
5639
|
+
/** Should include shipping in refund calculation */
|
|
5640
|
+
refundShipping?: boolean;
|
|
5641
|
+
}
|
|
5642
|
+
interface CalculateRefundItemRequest {
|
|
5605
5643
|
/**
|
|
5606
|
-
*
|
|
5644
|
+
* ID of the line item being refunded
|
|
5607
5645
|
* @format GUID
|
|
5608
5646
|
*/
|
|
5609
|
-
|
|
5610
|
-
}
|
|
5611
|
-
interface ServiceRemoved {
|
|
5647
|
+
_id?: string;
|
|
5612
5648
|
/**
|
|
5613
|
-
*
|
|
5614
|
-
* @
|
|
5649
|
+
* How much of that line item is being refunded
|
|
5650
|
+
* @min 1
|
|
5651
|
+
* @max 100000
|
|
5615
5652
|
*/
|
|
5616
|
-
|
|
5653
|
+
quantity?: number;
|
|
5654
|
+
}
|
|
5655
|
+
interface CalculateRefundResponse {
|
|
5656
|
+
/** Total refundable amount */
|
|
5657
|
+
total?: Price;
|
|
5658
|
+
/** Tax cost of the order */
|
|
5659
|
+
tax?: Price;
|
|
5660
|
+
/** Discount given for this order */
|
|
5661
|
+
discount?: Price;
|
|
5662
|
+
/** Total cost of the order (without tax) */
|
|
5663
|
+
subtotal?: Price;
|
|
5664
|
+
/** Total shipping cost for order */
|
|
5665
|
+
shipping?: Price;
|
|
5666
|
+
/** Previous refund given on that order */
|
|
5667
|
+
previouslyRefundedAmount?: Price;
|
|
5617
5668
|
/**
|
|
5618
|
-
*
|
|
5619
|
-
* @
|
|
5669
|
+
* The refundable items of that order
|
|
5670
|
+
* @maxSize 300
|
|
5620
5671
|
*/
|
|
5621
|
-
|
|
5672
|
+
items?: CalculateRefundItemResponse[];
|
|
5673
|
+
}
|
|
5674
|
+
interface CalculateRefundItemResponse {
|
|
5622
5675
|
/**
|
|
5623
|
-
*
|
|
5624
|
-
* @
|
|
5676
|
+
* Line item ID
|
|
5677
|
+
* @format GUID
|
|
5625
5678
|
*/
|
|
5626
|
-
|
|
5679
|
+
_id?: string;
|
|
5680
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
5681
|
+
price?: Price;
|
|
5627
5682
|
}
|
|
5628
|
-
|
|
5629
|
-
interface SiteRenamed {
|
|
5683
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
5630
5684
|
/**
|
|
5631
|
-
*
|
|
5632
|
-
* @
|
|
5685
|
+
* Wix eCommerce order ID
|
|
5686
|
+
* @minLength 1
|
|
5687
|
+
* @maxLength 100
|
|
5633
5688
|
*/
|
|
5634
|
-
|
|
5689
|
+
ecomOrderId: string;
|
|
5635
5690
|
/**
|
|
5636
|
-
*
|
|
5637
|
-
* @
|
|
5691
|
+
* Payment IDs
|
|
5692
|
+
* @minSize 1
|
|
5693
|
+
* @maxSize 100
|
|
5694
|
+
* @format GUID
|
|
5638
5695
|
*/
|
|
5639
|
-
|
|
5640
|
-
}
|
|
5641
|
-
/**
|
|
5642
|
-
* Hard deletion of the meta site.
|
|
5643
|
-
*
|
|
5644
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5645
|
-
*/
|
|
5646
|
-
interface SiteHardDeleted {
|
|
5647
|
-
/** A deletion context. */
|
|
5648
|
-
deleteContext?: DeleteContext;
|
|
5649
|
-
}
|
|
5650
|
-
interface NamespaceChanged {
|
|
5651
|
-
/** A previous namespace. */
|
|
5652
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
5653
|
-
/** A new namespace. */
|
|
5654
|
-
newNamespace?: NamespaceWithLiterals;
|
|
5655
|
-
}
|
|
5656
|
-
/** Assigned Studio editor */
|
|
5657
|
-
interface StudioAssigned {
|
|
5658
|
-
}
|
|
5659
|
-
/** Unassigned Studio editor */
|
|
5660
|
-
interface StudioUnassigned {
|
|
5696
|
+
paymentIds: string[];
|
|
5661
5697
|
}
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5666
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5667
|
-
*
|
|
5668
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
5669
|
-
*/
|
|
5670
|
-
interface SiteUrlChanged {
|
|
5698
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
5699
|
+
/** All order's transactions after the void was triggered */
|
|
5700
|
+
orderTransactions?: OrderTransactions;
|
|
5671
5701
|
}
|
|
5672
|
-
|
|
5673
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5674
|
-
* Consumed by other teams to remove relevant data.
|
|
5675
|
-
*/
|
|
5676
|
-
interface SitePurgedExternally {
|
|
5702
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
5677
5703
|
/**
|
|
5678
|
-
*
|
|
5704
|
+
* Wix eCommerce order ID
|
|
5705
|
+
* @minLength 1
|
|
5706
|
+
* @maxLength 100
|
|
5707
|
+
*/
|
|
5708
|
+
ecomOrderId: string;
|
|
5709
|
+
/**
|
|
5710
|
+
* Capture payments information
|
|
5711
|
+
* @minSize 1
|
|
5679
5712
|
* @maxSize 100
|
|
5680
|
-
* @deprecated
|
|
5681
|
-
* @targetRemovalDate 2025-04-15
|
|
5682
5713
|
*/
|
|
5683
|
-
|
|
5684
|
-
}
|
|
5685
|
-
/** Assigned Odeditor */
|
|
5686
|
-
interface OdeditorAssigned {
|
|
5687
|
-
}
|
|
5688
|
-
/** Unassigned Odeditor */
|
|
5689
|
-
interface OdeditorUnassigned {
|
|
5690
|
-
}
|
|
5691
|
-
/** Assigned Picasso editor */
|
|
5692
|
-
interface PicassoAssigned {
|
|
5693
|
-
}
|
|
5694
|
-
/** Unassigned Picasso */
|
|
5695
|
-
interface PicassoUnassigned {
|
|
5696
|
-
}
|
|
5697
|
-
/** Assigned Wixel */
|
|
5698
|
-
interface WixelAssigned {
|
|
5699
|
-
}
|
|
5700
|
-
/** Unassigned Wixel */
|
|
5701
|
-
interface WixelUnassigned {
|
|
5702
|
-
}
|
|
5703
|
-
/** Assigned StudioTwo */
|
|
5704
|
-
interface StudioTwoAssigned {
|
|
5705
|
-
}
|
|
5706
|
-
/** Unassigned StudioTwo */
|
|
5707
|
-
interface StudioTwoUnassigned {
|
|
5708
|
-
}
|
|
5709
|
-
/** Media from user domain is enabled. */
|
|
5710
|
-
interface UserDomainMediaEnabled {
|
|
5711
|
-
}
|
|
5712
|
-
/** Media from user domain is disabled. */
|
|
5713
|
-
interface UserDomainMediaDisabled {
|
|
5714
|
-
}
|
|
5715
|
-
/** Assigned Editorless */
|
|
5716
|
-
interface EditorlessAssigned {
|
|
5717
|
-
}
|
|
5718
|
-
/** Unassigned Editorless */
|
|
5719
|
-
interface EditorlessUnassigned {
|
|
5720
|
-
}
|
|
5721
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
5722
|
-
}
|
|
5723
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
5724
|
-
hasCustomConfigurations?: boolean;
|
|
5725
|
-
}
|
|
5726
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
5727
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
5728
|
-
sendCustomEmailConfigs?: boolean;
|
|
5729
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5730
|
-
origin?: OriginWithLiterals;
|
|
5714
|
+
payments: PaymentCapture[];
|
|
5731
5715
|
}
|
|
5732
|
-
|
|
5733
|
-
|
|
5734
|
-
|
|
5716
|
+
interface PaymentCapture {
|
|
5717
|
+
/**
|
|
5718
|
+
* Payment ID
|
|
5719
|
+
* @format GUID
|
|
5720
|
+
*/
|
|
5721
|
+
paymentId?: string | null;
|
|
5722
|
+
/**
|
|
5723
|
+
* Capture amount.
|
|
5724
|
+
* If not provided - full authorized amount will be captured.
|
|
5725
|
+
*/
|
|
5726
|
+
amount?: Price;
|
|
5735
5727
|
}
|
|
5736
|
-
|
|
5737
|
-
|
|
5738
|
-
|
|
5739
|
-
success?: boolean;
|
|
5728
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
5729
|
+
/** All order's transactions after the capture was triggered */
|
|
5730
|
+
orderTransactions?: OrderTransactions;
|
|
5740
5731
|
}
|
|
5741
|
-
interface
|
|
5732
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
5733
|
+
/**
|
|
5734
|
+
* Ecom Order ID.
|
|
5735
|
+
* @minLength 1
|
|
5736
|
+
* @maxLength 100
|
|
5737
|
+
*/
|
|
5738
|
+
ecomOrderId?: string;
|
|
5739
|
+
/** Amount to be charged */
|
|
5740
|
+
amount?: Price;
|
|
5742
5741
|
}
|
|
5743
|
-
interface
|
|
5744
|
-
|
|
5742
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
5743
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
5744
|
+
paymentGatewayOrderId?: string;
|
|
5745
5745
|
}
|
|
5746
5746
|
interface DiffmatokyPayload {
|
|
5747
5747
|
left?: string;
|
|
@@ -8706,4 +8706,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
8706
8706
|
unassignTags?: TagsTags;
|
|
8707
8707
|
}
|
|
8708
8708
|
|
|
8709
|
-
export { OrderActivityTypeEnumActivityType as $, type AddActivitiesOptions as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, PaymentOptionType as E, SubscriptionFrequency as F, type GetPaymentCollectabilityStatusResponse as G, AdjustmentType as H, ItemTypePreset as I, JurisdictionType as J, PaymentStatusEnumPaymentStatus as K, FulfillmentStatus as L, type MaskedOrder as M, VatType as N, type Order as O, type Price as P, PickupMethod as Q, OrderStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, DiscountType as X, DiscountReason as Y, LineItemQuantityChangeType as Z, ActivityType as _, type PreparePaymentCollectionOptions as a, type SubscriptionDescription as a$, AttributionSource as a0, ChannelType as a1, AdditionalFeeSource as a2, OrderActionType as a3, SpecificItemsCouponBehavior as a4, ChargeType as a5, DeltaPaymentOptionType as a6, InventoryAction as a7, WebhookIdentityType as a8, VersioningMode as a9, SubdivisionType as aA, SourceType as aB, CustomFieldGroup as aC, ValueType as aD, DepositType as aE, InvoiceStatus as aF, type OrderLineItem as aG, type ProductName as aH, type CatalogReference as aI, type DescriptionLine as aJ, type DescriptionLineValueOneOf as aK, type DescriptionLineDescriptionLineValueOneOf as aL, type DescriptionLineName as aM, type PlainTextValue as aN, type Color as aO, type FocalPoint as aP, type PhysicalProperties as aQ, type Dimensions as aR, type ItemType as aS, type ItemTypeItemTypeDataOneOf as aT, type RestockLocation as aU, type ItemTaxFullDetails as aV, type LineItemTaxInfo as aW, type LineItemTaxBreakdown as aX, type DigitalFile as aY, type SubscriptionInfo as aZ, type SubscriptionTitle as a_, ScheduledAction as aa, DurationUnit as ab, PaymentCollectabilityStatus as ac, PredefinedPaymentMethod as ad, RefundableStatus as ae, NonRefundableReason as af, ManuallyRefundableReason as ag, RestockType as ah, TransactionStatus as ai, AuthorizationCaptureStatus as aj, AuthorizationVoidStatus as ak, Reason as al, ActionType as am, ChargebackStatus as an, MembershipPaymentStatus as ao, PaymentStatus as ap, RefundStatus as aq, PreviewEmailType as ar, State as as, SiteCreatedContext as at, Namespace as au, DeleteStatus as av, Origin as aw, SortOrder as ax, OrderApprovalStrategy as ay, Placement as az, type PreparePaymentCollectionResponse as b, type TranslatedValue as b$, type SubscriptionSettings as b0, type FreeTrialPeriod as b1, type BillingSettings as b2, type BillingAdjustment as b3, type BillingAdjustmentPriceSummary as b4, type PriceDescription as b5, type LocationAndQuantity as b6, type TaxableAddress as b7, type TaxableAddressTaxableAddressDataOneOf as b8, type ExtendedFields as b9, type Coupon as bA, type MerchantDiscount as bB, type MerchantDiscountMerchantDiscountReasonOneOf as bC, type DiscountRule as bD, type DiscountRuleName as bE, type LineItemDiscount as bF, type ItemCombination as bG, type ItemCombinationLineItem as bH, type Activity as bI, type ActivityContentOneOf as bJ, type CustomActivity as bK, type MerchantComment as bL, type OrderRefunded as bM, type OrderCreatedFromExchange as bN, type NewExchangeOrderCreated as bO, type LineItemExchangeData as bP, type DraftOrderChangesApplied as bQ, type OrderChange as bR, type OrderChangeValueOneOf as bS, type LineItemChanges as bT, type LineItemQuantityChange as bU, type LineItemPriceChange as bV, type LineItemProductNameChange as bW, type LineItemDescriptionLineChange as bX, type LineItemModifiersChange as bY, type ManagedLineItem as bZ, type ManagedDiscount as b_, type ModifierGroup as ba, type TranslatableString as bb, type ItemModifier as bc, type BuyerInfo as bd, type BuyerInfoIdOneOf as be, type CurrencyConversionDetails as bf, type PriceSummary as bg, type AddressWithContact as bh, type Address as bi, type StreetAddress as bj, type AddressLocation as bk, type FullAddressContactDetails as bl, type VatId as bm, type V1ShippingInformation as bn, type DeliveryLogistics as bo, type DeliveryLogisticsAddressOneOf as bp, type PickupDetails as bq, type PickupAddress as br, type DeliveryTimeSlot as bs, type ShippingPrice as bt, type ShippingRegion as bu, type TaxSummary as bv, type OrderTaxInfo as bw, type OrderTaxBreakdown as bx, type AppliedDiscount as by, type AppliedDiscountDiscountSourceOneOf as bz, type PreparePaymentCollectionApplicationErrors as c, type PaymentStatusUpdated as c$, type LineItemAmount as c0, type ManagedAdditionalFee as c1, type TotalPriceChange as c2, type ShippingInformationChange as c3, type ShippingInformation as c4, type SavedPaymentMethod as c5, type AuthorizedPaymentCreated as c6, type AuthorizedPaymentCaptured as c7, type AuthorizedPaymentVoided as c8, type RefundInitiated as c9, type CreatedByStringOneOf as cA, type ChannelInfo as cB, type CustomField as cC, type BalanceSummary as cD, type Balance as cE, type CashRounding as cF, type AdditionalFee as cG, type FulfillmentStatusesAggregate as cH, type Tags as cI, type TagList as cJ, type Location as cK, type OrderSettings as cL, type OrderSettingsAllowedActionsOneOf as cM, type OrderSettingsEditableByOneOf as cN, type CustomAllowedActions as cO, type OwnerApps as cP, type FormInfo as cQ, type FormIdentifier as cR, type PlatformFeeSummary as cS, type PlatformFee as cT, type OrderApproved as cU, type OrdersExperiments as cV, type OrderRejectedEventOrderRejected as cW, type OrderItemsRestocked as cX, type V1RestockItem as cY, type OrderImported as cZ, type ImportedOrderDeleted as c_, type RefundedPayment as ca, type RefundedPaymentKindOneOf as cb, type RegularPaymentRefund as cc, type GiftCardPaymentRefund as cd, type MembershipPaymentRefund as ce, type PaymentRefunded as cf, type PaymentRefundFailed as cg, type RefundedAsStoreCredit as ch, type PaymentPending as ci, type PaymentPendingPaymentDetailsOneOf as cj, type RegularPayment as ck, type RegularPaymentPaymentMethodDetailsOneOf as cl, type CreditCardDetails as cm, type PaymentCanceled as cn, type PaymentCanceledPaymentDetailsOneOf as co, type PaymentDeclined as cp, type PaymentDeclinedPaymentDetailsOneOf as cq, type ReceiptCreated as cr, type ReceiptCreatedReceiptInfoOneOf as cs, type WixReceipt as ct, type ExternalReceipt as cu, type ReceiptSent as cv, type ReceiptSentReceiptInfoOneOf as cw, type ChargebackCreated as cx, type ChargebackReversed as cy, type CreatedBy as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type ApplicationError as d$, type FulfillmentStatusUpdated as d0, type OrderCanceledEventOrderCanceled as d1, type OrderDeltasCommitted as d2, type CommittedDiffs as d3, type CommittedDiffsShippingUpdateInfoOneOf as d4, type ItemChangedDetails as d5, type OrderLineItemChangedDetails as d6, type LineItemDelta as d7, type LineItemDeltaDeltaOneOf as d8, type AppliedDiscountDelta as d9, type InternalDocumentUpdateOperation as dA, type DeleteByIdsOperation as dB, type DeleteByFilterOperation as dC, type InternalDocumentUpdateByFilterOperation as dD, type InternalUpdateExistingOperation as dE, type VersionedDocumentUpdateOperation as dF, type VersionedDeleteByIdsOperation as dG, type VersionedDocumentId as dH, type TriggerReindexRequest as dI, type TriggerReindexResponse as dJ, type Empty as dK, type TriggerReindexOrderRequest as dL, type PreparePaymentCollectionRequest as dM, type RedirectUrls as dN, type DelayedCaptureSettings as dO, type Duration as dP, type GetPaymentCollectabilityStatusRequest as dQ, type RecordManuallyCollectedPaymentRequest as dR, type UserDefinedPaymentMethodName as dS, type UserDefinedPaymentMethodNameKindOneOf as dT, type RecordManuallyCollectedPaymentResponse as dU, type MarkOrderAsPaidRequest as dV, type MarkOrderAsPaidResponse as dW, type BulkMarkOrdersAsPaidRequest as dX, type BulkMarkOrdersAsPaidResponse as dY, type BulkOrderResult as dZ, type ItemMetadata as d_, type AppliedDiscountDeltaDeltaOneOf as da, type AdditionalFeeDelta as db, type AdditionalFeeDeltaDeltaOneOf as dc, type DraftOrderCommitSettings as dd, type InventoryUpdateDetails as de, type ImportOrderRequest as df, type ImportOrderResponse as dg, type SetOrderNumberCounterRequest as dh, type SetOrderNumberCounterResponse as di, type BulkDeleteImportedOrdersRequest as dj, type BulkDeleteImportedOrdersResponse as dk, type DomainEvent as dl, type DomainEventBodyOneOf as dm, type EntityCreatedEvent as dn, type RestoreInfo as dp, type EntityUpdatedEvent as dq, type EntityDeletedEvent as dr, type ActionEvent as ds, type MessageEnvelope as dt, type IdentificationData as du, type IdentificationDataIdOneOf as dv, type AccountInfo as dw, type UpdateInternalDocumentsEvent as dx, type UpdateInternalDocumentsEventOperationOneOf as dy, type InternalDocument as dz, type PaymentCapture as e, type BulkSendBuyerPickupConfirmationEmailsRequest as e$, type BulkActionMetadata as e0, type GetRefundabilityStatusRequest as e1, type GetRefundabilityStatusResponse as e2, type Refundability as e3, type RefundabilityAdditionalRefundabilityInfoOneOf as e4, type CreatePaymentGatewayOrderRequest as e5, type ChargedBy as e6, type CreatePaymentGatewayOrderResponse as e7, type ChargeMembershipsRequest as e8, type MembershipChargeItem as e9, type Chargeback as eA, type PaymentMethodName as eB, type GiftCardPaymentDetails as eC, type MembershipPaymentDetails as eD, type WixReceiptInfo as eE, type ExternalReceiptInfo as eF, type CashRoundingDetails as eG, type Refund as eH, type RefundTransaction as eI, type RefundStatusInfo as eJ, type AggregatedRefundSummary as eK, type RefundItemsBreakdown as eL, type LineItemRefundSummary as eM, type CalculateRefundRequest as eN, type CalculateRefundItemRequest as eO, type CalculateRefundResponse as eP, type CalculateRefundItemResponse as eQ, type VoidAuthorizedPaymentsRequest as eR, type CaptureAuthorizedPaymentsRequest as eS, type ChargeSavedPaymentMethodRequest as eT, type ChargeSavedPaymentMethodResponse as eU, type SendBuyerConfirmationEmailRequest as eV, type SendBuyerConfirmationEmailResponse as eW, type SendBuyerPaymentsReceivedEmailRequest as eX, type SendBuyerPaymentsReceivedEmailResponse as eY, type SendBuyerPickupConfirmationEmailRequest as eZ, type SendBuyerPickupConfirmationEmailResponse as e_, type MembershipName as ea, type ServiceProperties as eb, type ChargeMembershipsResponse as ec, type TriggerRefundRequest as ed, type PaymentRefund as ee, type RefundDetails as ef, type RefundItem as eg, type LineItemRefund as eh, type AdditionalFeeRefund as ei, type ShippingRefund as ej, type RefundSideEffects as ek, type RestockInfo as el, type RestockItem as em, type TriggerRefundResponse as en, type OrderTransactions as eo, type Payment as ep, type PaymentPaymentDetailsOneOf as eq, type PaymentReceiptInfoOneOf as er, type RegularPaymentDetails as es, type RegularPaymentDetailsPaymentMethodDetailsOneOf as et, type CreditCardPaymentMethodDetails as eu, type AuthorizationDetails as ev, type AuthorizationCapture as ew, type AuthorizationActionFailureDetails as ex, type AuthorizationVoid as ey, type V1ScheduledAction as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type UserDomainMediaDisabled as f$, type BulkSendBuyerPickupConfirmationEmailsResponse as f0, type SendBuyerShippingConfirmationEmailRequest as f1, type SendBuyerShippingConfirmationEmailResponse as f2, type BulkSendBuyerShippingConfirmationEmailsRequest as f3, type BulkSendBuyerShippingConfirmationEmailsResponse as f4, type SendMerchantOrderReceivedNotificationRequest as f5, type SendMerchantOrderReceivedNotificationResponse as f6, type SendCancelRefundEmailRequest as f7, type SendCancelRefundEmailResponse as f8, type SendRefundEmailRequest as f9, type SiteCreated as fA, type SiteTransferred as fB, type SiteDeleted as fC, type DeleteContext as fD, type SiteUndeleted as fE, type SitePublished as fF, type SiteUnpublished as fG, type SiteMarkedAsTemplate as fH, type SiteMarkedAsWixSite as fI, type ServiceProvisioned as fJ, type ServiceRemoved as fK, type SiteRenamed as fL, type SiteHardDeleted as fM, type NamespaceChanged as fN, type StudioAssigned as fO, type StudioUnassigned as fP, type SiteUrlChanged as fQ, type SitePurgedExternally as fR, type OdeditorAssigned as fS, type OdeditorUnassigned as fT, type PicassoAssigned as fU, type PicassoUnassigned as fV, type WixelAssigned as fW, type WixelUnassigned as fX, type StudioTwoAssigned as fY, type StudioTwoUnassigned as fZ, type UserDomainMediaEnabled as f_, type SendRefundEmailResponse as fa, type SendFulfillmentEmailRequest as fb, type SendFulfillmentEmailResponse as fc, type SendMerchantOrderReceivedPushRequest as fd, type SendMerchantOrderReceivedPushResponse as fe, type PreviewEmailByTypeRequest as ff, type PreviewEmailByTypeResponse as fg, type PreviewRefundEmailRequest as fh, type PreviewRefundEmailResponse as fi, type PreviewCancelEmailRequest as fj, type PreviewCancelEmailResponse as fk, type PreviewCancelRefundEmailRequest as fl, type PreviewCancelRefundEmailResponse as fm, type PreviewBuyerPaymentsReceivedEmailRequest as fn, type PreviewBuyerPaymentsReceivedEmailResponse as fo, type PreviewBuyerConfirmationEmailRequest as fp, type PreviewBuyerConfirmationEmailResponse as fq, type PreviewBuyerPickupConfirmationEmailRequest as fr, type PreviewBuyerPickupConfirmationEmailResponse as fs, type PreviewShippingConfirmationEmailRequest as ft, type PreviewShippingConfirmationEmailResponse as fu, type PreviewResendDownloadLinksEmailRequest as fv, type PreviewResendDownloadLinksEmailResponse as fw, type MetaSiteSpecialEvent as fx, type MetaSiteSpecialEventPayloadOneOf as fy, type Asset as fz, type GetOrderApplicationErrors as g, type UpdateBillingContactDetailsRequest as g$, type EditorlessAssigned as g0, type EditorlessUnassigned as g1, type HasCustomEmailConfigurationsRequest as g2, type HasCustomEmailConfigurationsResponse as g3, type AddToAutomationMigrationPopulationRequest as g4, type AddToAutomationMigrationPopulationResponse as g5, type IsInAutomationMigrationPopulationRequest as g6, type IsInAutomationMigrationPopulationResponse as g7, type DiffmatokyPayload as g8, type ErrorInformation as g9, type DraftOrderDiffs as gA, type DraftOrderDiffsShippingUpdateInfoOneOf as gB, type DraftOrderDiffsBuyerUpdateInfoOneOf as gC, type DraftOrderDiffsBillingUpdateInfoOneOf as gD, type DraftOrderDiffsRecipientUpdateInfoOneOf as gE, type V1LineItemDelta as gF, type V1LineItemDeltaDeltaOneOf as gG, type CommitDeltasResponse as gH, type ArchiveOrderRequest as gI, type ArchiveOrderResponse as gJ, type BulkArchiveOrdersRequest as gK, type BulkArchiveOrdersResponse as gL, type BulkArchiveOrdersByFilterRequest as gM, type BulkArchiveOrdersByFilterResponse as gN, type UnArchiveOrderRequest as gO, type UnArchiveOrderResponse as gP, type BulkUnArchiveOrdersRequest as gQ, type BulkUnArchiveOrdersResponse as gR, type BulkUnArchiveOrdersByFilterRequest as gS, type BulkUnArchiveOrdersByFilterResponse as gT, type UpdateBuyerInfoRequest as gU, type BuyerInfoUpdate as gV, type UpdateBuyerInfoResponse as gW, type UpdateBuyerEmailRequest as gX, type UpdateBuyerEmailResponse as gY, type UpdateOrderShippingAddressRequest as gZ, type UpdateOrderShippingAddressResponse as g_, type GetOrderRequest as ga, type GetOrderResponse as gb, type InternalQueryOrdersRequest as gc, type PlatformQuery as gd, type PlatformQueryPagingMethodOneOf as ge, type Sorting as gf, type PlatformPaging as gg, type CursorPaging as gh, type InternalQueryOrdersResponse as gi, type PlatformPagingMetadata as gj, type Cursors as gk, type QueryOrderRequest as gl, type QueryOrderResponse as gm, type SearchOrdersRequest as gn, type CursorSearch as go, type CursorSearchPagingMethodOneOf as gp, type CursorPagingMetadata as gq, type CreateOrderRequest as gr, type OrderCreationSettings as gs, type OrderCreationSettingsEditableByOneOf as gt, type OrderCreateNotifications as gu, type CreateOrderResponse as gv, type UpdateOrderRequest as gw, type UpdateOrderResponse as gx, type BulkUpdateOrdersRequest as gy, type CommitDeltasRequest as gz, type OrderSearch as h, type V1BulkMarkOrdersAsPaidRequest as h$, type UpdateBillingContactDetailsResponse as h0, type UpdateOrderLineItemRequest as h1, type UpdateOrderLineItemResponse as h2, type UpdateOrderLineItemsRequest as h3, type MaskedOrderLineItem as h4, type UpdateOrderLineItemsResponse as h5, type AddInternalActivityRequest as h6, type InternalActivity as h7, type InternalActivityContentOneOf as h8, type OrderPlaced as h9, type DeleteActivityRequest as hA, type DeleteActivityResponse as hB, type UpdateLineItemsDescriptionLinesRequest as hC, type LineItemUpdate as hD, type UpdateLineItemsDescriptionLinesResponse as hE, type MarkOrderAsSeenByHumanRequest as hF, type MarkOrderAsSeenByHumanResponse as hG, type CancelOrderRequest as hH, type UpdateOrderStatusRequest as hI, type UpdateOrderStatusResponse as hJ, type MarkAsFulfilledRequest as hK, type MarkAsFulfilledResponse as hL, type BulkMarkAsFulfilledRequest as hM, type BulkMarkAsFulfilledResponse as hN, type BulkMarkAsFulfilledByFilterRequest as hO, type BulkMarkAsFulfilledByFilterResponse as hP, type MarkAsUnfulfilledRequest as hQ, type MarkAsUnfulfilledResponse as hR, type BulkMarkAsUnfulfilledRequest as hS, type BulkMarkAsUnfulfilledResponse as hT, type BulkMarkAsUnfulfilledByFilterRequest as hU, type BulkMarkAsUnfulfilledByFilterResponse as hV, type BulkSetBusinessLocationRequest as hW, type BulkSetBusinessLocationResponse as hX, type BulkSetBusinessLocationResult as hY, type V1MarkOrderAsPaidRequest as hZ, type V1MarkOrderAsPaidResponse as h_, type OrderPaid as ha, type OrderFulfilled as hb, type OrderNotFulfilled as hc, type OrderCanceled as hd, type DownloadLinkSent as he, type TrackingNumberAdded as hf, type TrackingNumberEdited as hg, type TrackingLinkAdded as hh, type ShippingConfirmationEmailSent as hi, type InvoiceAdded as hj, type InvoiceSent as hk, type FulfillerEmailSent as hl, type ShippingAddressEdited as hm, type EmailEdited as hn, type PickupReadyEmailSent as ho, type OrderPartiallyPaid as hp, type OrderPending as hq, type OrderRejected as hr, type AddInternalActivityResponse as hs, type AddActivityRequest as ht, type PublicActivity as hu, type PublicActivityContentOneOf as hv, type AddActivityResponse as hw, type AddActivitiesRequest as hx, type UpdateActivityRequest as hy, type UpdateActivityResponse as hz, type CreateOrderOptions as i, type RecordManuallyCollectedPaymentOptions as i$, type V1BulkMarkOrdersAsPaidResponse as i0, type V1CreatePaymentGatewayOrderRequest as i1, type V1CreatePaymentGatewayOrderResponse as i2, type GetShipmentsRequest as i3, type GetShipmentsResponse as i4, type AggregateOrdersRequest as i5, type AggregateOrdersResponse as i6, type DecrementItemsQuantityRequest as i7, type DecrementData as i8, type DecrementItemsQuantityResponse as i9, type Subdivision as iA, type StandardDetails as iB, type InvoiceDates as iC, type LineItems as iD, type LineItem as iE, type BigDecimalWrapper as iF, type LineItemTax as iG, type Source as iH, type LineItemMetaData as iI, type Locale as iJ, type TotalPrice as iK, type ItemizedFee as iL, type Discount as iM, type DiscountOneDiscountTypeOneOf as iN, type CalculatedTaxes as iO, type CalculatedTax as iP, type Payments as iQ, type InvoicesPayment as iR, type MetaData as iS, type InvoiceDynamicPriceTotals as iT, type CustomFieldValue as iU, type Value as iV, type Deposit as iW, type BaseEventMetadata as iX, type EventMetadata as iY, type AccountInfoMetadata as iZ, type SetOrderNumberCounterOptions as i_, type BulkUpdateOrderTagsRequest as ia, type TagsTags as ib, type TagsTagList as ic, type BulkUpdateOrderTagsResult as id, type SendOrderUpdatedDomainEventRequest as ie, type SendOrderUpdatedDomainEventResponse as ig, type Task as ih, type TaskKey as ii, type TaskAction as ij, type TaskActionActionOneOf as ik, type Complete as il, type Cancel as im, type Reschedule as io, type InvoiceSentEvent as ip, type IdAndVersion as iq, type InvoiceFields as ir, type Customer as is, type Email as it, type QuotesAddress as iu, type AddressDescription as iv, type Phone as iw, type Company as ix, type CommonAddress as iy, type CommonAddressStreetOneOf as iz, type CreateOrderApplicationErrors as j, type SortOrderWithLiterals as j$, type PaymentCollectionMarkOrderAsPaidOptions as j0, type PaymentCollectionCreatePaymentGatewayOrderOptions as j1, type ChargeMembershipsOptions as j2, type TriggerRefundOptions as j3, type OrderSearchSpec as j4, type UpdateOrderLineItemIdentifiers as j5, type UpdateOrderLineItem as j6, type UpdateActivityIdentifiers as j7, type DeleteActivityIdentifiers as j8, type AggregateOrdersOptions as j9, type DeltaPaymentOptionTypeWithLiterals as jA, type InventoryActionWithLiterals as jB, type WebhookIdentityTypeWithLiterals as jC, type VersioningModeWithLiterals as jD, type ScheduledActionWithLiterals as jE, type DurationUnitWithLiterals as jF, type PaymentCollectabilityStatusWithLiterals as jG, type PredefinedPaymentMethodWithLiterals as jH, type RefundableStatusWithLiterals as jI, type NonRefundableReasonWithLiterals as jJ, type ManuallyRefundableReasonWithLiterals as jK, type RestockTypeWithLiterals as jL, type TransactionStatusWithLiterals as jM, type AuthorizationCaptureStatusWithLiterals as jN, type AuthorizationVoidStatusWithLiterals as jO, type ReasonWithLiterals as jP, type ActionTypeWithLiterals as jQ, type ChargebackStatusWithLiterals as jR, type MembershipPaymentStatusWithLiterals as jS, type PaymentStatusWithLiterals as jT, type RefundStatusWithLiterals as jU, type PreviewEmailTypeWithLiterals as jV, type StateWithLiterals as jW, type SiteCreatedContextWithLiterals as jX, type NamespaceWithLiterals as jY, type DeleteStatusWithLiterals as jZ, type OriginWithLiterals as j_, utils as ja, type DescriptionLineTypeWithLiterals as jb, type DimensionsUnitWithLiterals as jc, type ItemTypePresetWithLiterals as jd, type PaymentOptionTypeWithLiterals as je, type JurisdictionTypeWithLiterals as jf, type SubscriptionFrequencyWithLiterals as jg, type AdjustmentTypeWithLiterals as jh, type TaxableAddressTypeWithLiterals as ji, type PaymentStatusEnumPaymentStatusWithLiterals as jj, type FulfillmentStatusWithLiterals as jk, type WeightUnitWithLiterals as jl, type VatTypeWithLiterals as jm, type PickupMethodWithLiterals as jn, type OrderStatusWithLiterals as jo, type DiscountTypeWithLiterals as jp, type DiscountReasonWithLiterals as jq, type LineItemQuantityChangeTypeWithLiterals as jr, type ActivityTypeWithLiterals as js, type OrderActivityTypeEnumActivityTypeWithLiterals as jt, type AttributionSourceWithLiterals as ju, type ChannelTypeWithLiterals as jv, type AdditionalFeeSourceWithLiterals as jw, type OrderActionTypeWithLiterals as jx, type SpecificItemsCouponBehaviorWithLiterals as jy, type ChargeTypeWithLiterals as jz, type UpdateOrderApplicationErrors as k, type OrderApprovalStrategyWithLiterals as k0, type PlacementWithLiterals as k1, type SubdivisionTypeWithLiterals as k2, type SourceTypeWithLiterals as k3, type CustomFieldGroupWithLiterals as k4, type ValueTypeWithLiterals as k5, type DepositTypeWithLiterals as k6, type InvoiceStatusWithLiterals as k7, type RecordManuallyCollectedPaymentApplicationErrors as k8, type PaymentCollectionMarkOrderAsPaidApplicationErrors as k9, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as ka, type TriggerRefundApplicationErrors as kb, type UpdateOrderStatusApplicationErrors as kc, type CommonSearchWithEntityContext as kd, onOrderApproved as ke, onOrderCanceled as kf, onOrderCommitted as kg, onOrderCreated as kh, onOrderFulfilled as ki, onOrderPaymentStatusUpdated as kj, onOrderUpdated as kk, preparePaymentCollection as kl, getPaymentCollectabilityStatus as km, voidAuthorizedPayments as kn, captureAuthorizedPayments as ko, getOrder as kp, createOrder as kq, updateOrder as kr, bulkUpdateOrders as ks, addActivities as kt, cancelOrder as ku, bulkUpdateOrderTags as kv, type BulkUpdateOrdersResponse as l, type AddActivitiesResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type BulkUpdateOrderTagsOptions as q, type BulkUpdateOrderTagsResponse as r, type OrderApprovedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCommittedEnvelope as u, type OrderCreatedEnvelope as v, type OrderFulfilledEnvelope as w, type OrderPaymentStatusUpdatedEnvelope as x, type OrderUpdatedEnvelope as y, DimensionsUnit as z };
|
|
8709
|
+
export { OrderActivityTypeEnumActivityType as $, type AddActivitiesOptions as A, type BulkUpdateOrdersOptions as B, type CaptureAuthorizedPaymentsResponse as C, DescriptionLineType as D, PaymentOptionType as E, SubscriptionFrequency as F, type GetPaymentCollectabilityStatusResponse as G, AdjustmentType as H, ItemTypePreset as I, JurisdictionType as J, PaymentStatusEnumPaymentStatus as K, FulfillmentStatus as L, type MaskedOrder as M, VatType as N, type Order as O, type Price as P, PickupMethod as Q, OrderStatus as R, type SearchOrdersResponse as S, TaxableAddressType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, WeightUnit as W, DiscountType as X, DiscountReason as Y, LineItemQuantityChangeType as Z, ActivityType as _, type PreparePaymentCollectionOptions as a, type SubscriptionDescription as a$, AttributionSource as a0, ChannelType as a1, AdditionalFeeSource as a2, OrderActionType as a3, SpecificItemsCouponBehavior as a4, ChargeType as a5, DeltaPaymentOptionType as a6, InventoryAction as a7, WebhookIdentityType as a8, VersioningMode as a9, SubdivisionType as aA, SourceType as aB, CustomFieldGroup as aC, ValueType as aD, DepositType as aE, InvoiceStatus as aF, type OrderLineItem as aG, type ProductName as aH, type CatalogReference as aI, type DescriptionLine as aJ, type DescriptionLineValueOneOf as aK, type DescriptionLineDescriptionLineValueOneOf as aL, type DescriptionLineName as aM, type PlainTextValue as aN, type Color as aO, type FocalPoint as aP, type PhysicalProperties as aQ, type Dimensions as aR, type ItemType as aS, type ItemTypeItemTypeDataOneOf as aT, type RestockLocation as aU, type ItemTaxFullDetails as aV, type LineItemTaxInfo as aW, type LineItemTaxBreakdown as aX, type DigitalFile as aY, type SubscriptionInfo as aZ, type SubscriptionTitle as a_, PreviewEmailType as aa, State as ab, SiteCreatedContext as ac, Namespace as ad, DeleteStatus as ae, Origin as af, ScheduledAction as ag, DurationUnit as ah, PaymentCollectabilityStatus as ai, PredefinedPaymentMethod as aj, RefundableStatus as ak, NonRefundableReason as al, ManuallyRefundableReason as am, RestockType as an, TransactionStatus as ao, AuthorizationCaptureStatus as ap, AuthorizationVoidStatus as aq, Reason as ar, ActionType as as, ChargebackStatus as at, MembershipPaymentStatus as au, PaymentStatus as av, RefundStatus as aw, SortOrder as ax, OrderApprovalStrategy as ay, Placement as az, type PreparePaymentCollectionResponse as b, type TranslatedValue as b$, type SubscriptionSettings as b0, type FreeTrialPeriod as b1, type BillingSettings as b2, type BillingAdjustment as b3, type BillingAdjustmentPriceSummary as b4, type PriceDescription as b5, type LocationAndQuantity as b6, type TaxableAddress as b7, type TaxableAddressTaxableAddressDataOneOf as b8, type ExtendedFields as b9, type Coupon as bA, type MerchantDiscount as bB, type MerchantDiscountMerchantDiscountReasonOneOf as bC, type DiscountRule as bD, type DiscountRuleName as bE, type LineItemDiscount as bF, type ItemCombination as bG, type ItemCombinationLineItem as bH, type Activity as bI, type ActivityContentOneOf as bJ, type CustomActivity as bK, type MerchantComment as bL, type OrderRefunded as bM, type OrderCreatedFromExchange as bN, type NewExchangeOrderCreated as bO, type LineItemExchangeData as bP, type DraftOrderChangesApplied as bQ, type OrderChange as bR, type OrderChangeValueOneOf as bS, type LineItemChanges as bT, type LineItemQuantityChange as bU, type LineItemPriceChange as bV, type LineItemProductNameChange as bW, type LineItemDescriptionLineChange as bX, type LineItemModifiersChange as bY, type ManagedLineItem as bZ, type ManagedDiscount as b_, type ModifierGroup as ba, type TranslatableString as bb, type ItemModifier as bc, type BuyerInfo as bd, type BuyerInfoIdOneOf as be, type CurrencyConversionDetails as bf, type PriceSummary as bg, type AddressWithContact as bh, type Address as bi, type StreetAddress as bj, type AddressLocation as bk, type FullAddressContactDetails as bl, type VatId as bm, type V1ShippingInformation as bn, type DeliveryLogistics as bo, type DeliveryLogisticsAddressOneOf as bp, type PickupDetails as bq, type PickupAddress as br, type DeliveryTimeSlot as bs, type ShippingPrice as bt, type ShippingRegion as bu, type TaxSummary as bv, type OrderTaxInfo as bw, type OrderTaxBreakdown as bx, type AppliedDiscount as by, type AppliedDiscountDiscountSourceOneOf as bz, type PreparePaymentCollectionApplicationErrors as c, type PaymentStatusUpdated as c$, type LineItemAmount as c0, type ManagedAdditionalFee as c1, type TotalPriceChange as c2, type ShippingInformationChange as c3, type ShippingInformation as c4, type SavedPaymentMethod as c5, type AuthorizedPaymentCreated as c6, type AuthorizedPaymentCaptured as c7, type AuthorizedPaymentVoided as c8, type RefundInitiated as c9, type CreatedByStringOneOf as cA, type ChannelInfo as cB, type CustomField as cC, type BalanceSummary as cD, type Balance as cE, type CashRounding as cF, type AdditionalFee as cG, type FulfillmentStatusesAggregate as cH, type Tags as cI, type TagList as cJ, type Location as cK, type OrderSettings as cL, type OrderSettingsAllowedActionsOneOf as cM, type OrderSettingsEditableByOneOf as cN, type CustomAllowedActions as cO, type OwnerApps as cP, type FormInfo as cQ, type FormIdentifier as cR, type PlatformFeeSummary as cS, type PlatformFee as cT, type OrderApproved as cU, type OrdersExperiments as cV, type OrderRejectedEventOrderRejected as cW, type OrderItemsRestocked as cX, type V1RestockItem as cY, type OrderImported as cZ, type ImportedOrderDeleted as c_, type RefundedPayment as ca, type RefundedPaymentKindOneOf as cb, type RegularPaymentRefund as cc, type GiftCardPaymentRefund as cd, type MembershipPaymentRefund as ce, type PaymentRefunded as cf, type PaymentRefundFailed as cg, type RefundedAsStoreCredit as ch, type PaymentPending as ci, type PaymentPendingPaymentDetailsOneOf as cj, type RegularPayment as ck, type RegularPaymentPaymentMethodDetailsOneOf as cl, type CreditCardDetails as cm, type PaymentCanceled as cn, type PaymentCanceledPaymentDetailsOneOf as co, type PaymentDeclined as cp, type PaymentDeclinedPaymentDetailsOneOf as cq, type ReceiptCreated as cr, type ReceiptCreatedReceiptInfoOneOf as cs, type WixReceipt as ct, type ExternalReceipt as cu, type ReceiptSent as cv, type ReceiptSentReceiptInfoOneOf as cw, type ChargebackCreated as cx, type ChargebackReversed as cy, type CreatedBy as cz, type VoidAuthorizedPaymentsApplicationErrors as d, type SendCancelRefundEmailResponse as d$, type FulfillmentStatusUpdated as d0, type OrderCanceledEventOrderCanceled as d1, type OrderDeltasCommitted as d2, type CommittedDiffs as d3, type CommittedDiffsShippingUpdateInfoOneOf as d4, type ItemChangedDetails as d5, type OrderLineItemChangedDetails as d6, type LineItemDelta as d7, type LineItemDeltaDeltaOneOf as d8, type AppliedDiscountDelta as d9, type InternalDocumentUpdateOperation as dA, type DeleteByIdsOperation as dB, type DeleteByFilterOperation as dC, type InternalDocumentUpdateByFilterOperation as dD, type InternalUpdateExistingOperation as dE, type VersionedDocumentUpdateOperation as dF, type VersionedDeleteByIdsOperation as dG, type VersionedDocumentId as dH, type TriggerReindexRequest as dI, type TriggerReindexResponse as dJ, type Empty as dK, type TriggerReindexOrderRequest as dL, type SendBuyerConfirmationEmailRequest as dM, type SendBuyerConfirmationEmailResponse as dN, type SendBuyerPaymentsReceivedEmailRequest as dO, type SendBuyerPaymentsReceivedEmailResponse as dP, type SendBuyerPickupConfirmationEmailRequest as dQ, type SendBuyerPickupConfirmationEmailResponse as dR, type BulkSendBuyerPickupConfirmationEmailsRequest as dS, type BulkSendBuyerPickupConfirmationEmailsResponse as dT, type SendBuyerShippingConfirmationEmailRequest as dU, type SendBuyerShippingConfirmationEmailResponse as dV, type BulkSendBuyerShippingConfirmationEmailsRequest as dW, type BulkSendBuyerShippingConfirmationEmailsResponse as dX, type SendMerchantOrderReceivedNotificationRequest as dY, type SendMerchantOrderReceivedNotificationResponse as dZ, type SendCancelRefundEmailRequest as d_, type AppliedDiscountDeltaDeltaOneOf as da, type AdditionalFeeDelta as db, type AdditionalFeeDeltaDeltaOneOf as dc, type DraftOrderCommitSettings as dd, type InventoryUpdateDetails as de, type ImportOrderRequest as df, type ImportOrderResponse as dg, type SetOrderNumberCounterRequest as dh, type SetOrderNumberCounterResponse as di, type BulkDeleteImportedOrdersRequest as dj, type BulkDeleteImportedOrdersResponse as dk, type DomainEvent as dl, type DomainEventBodyOneOf as dm, type EntityCreatedEvent as dn, type RestoreInfo as dp, type EntityUpdatedEvent as dq, type EntityDeletedEvent as dr, type ActionEvent as ds, type MessageEnvelope as dt, type IdentificationData as du, type IdentificationDataIdOneOf as dv, type AccountInfo as dw, type UpdateInternalDocumentsEvent as dx, type UpdateInternalDocumentsEventOperationOneOf as dy, type InternalDocument as dz, type PaymentCapture as e, type HasCustomEmailConfigurationsResponse as e$, type SendRefundEmailRequest as e0, type SendRefundEmailResponse as e1, type SendFulfillmentEmailRequest as e2, type SendFulfillmentEmailResponse as e3, type SendMerchantOrderReceivedPushRequest as e4, type SendMerchantOrderReceivedPushResponse as e5, type PreviewEmailByTypeRequest as e6, type PreviewEmailByTypeResponse as e7, type PreviewRefundEmailRequest as e8, type RefundDetails as e9, type SiteUndeleted as eA, type SitePublished as eB, type SiteUnpublished as eC, type SiteMarkedAsTemplate as eD, type SiteMarkedAsWixSite as eE, type ServiceProvisioned as eF, type ServiceRemoved as eG, type SiteRenamed as eH, type SiteHardDeleted as eI, type NamespaceChanged as eJ, type StudioAssigned as eK, type StudioUnassigned as eL, type SiteUrlChanged as eM, type SitePurgedExternally as eN, type OdeditorAssigned as eO, type OdeditorUnassigned as eP, type PicassoAssigned as eQ, type PicassoUnassigned as eR, type WixelAssigned as eS, type WixelUnassigned as eT, type StudioTwoAssigned as eU, type StudioTwoUnassigned as eV, type UserDomainMediaEnabled as eW, type UserDomainMediaDisabled as eX, type EditorlessAssigned as eY, type EditorlessUnassigned as eZ, type HasCustomEmailConfigurationsRequest as e_, type RefundItem as ea, type LineItemRefund as eb, type AdditionalFeeRefund as ec, type ShippingRefund as ed, type PreviewRefundEmailResponse as ee, type PreviewCancelEmailRequest as ef, type PreviewCancelEmailResponse as eg, type PreviewCancelRefundEmailRequest as eh, type PreviewCancelRefundEmailResponse as ei, type PreviewBuyerPaymentsReceivedEmailRequest as ej, type PreviewBuyerPaymentsReceivedEmailResponse as ek, type PreviewBuyerConfirmationEmailRequest as el, type PreviewBuyerConfirmationEmailResponse as em, type PreviewBuyerPickupConfirmationEmailRequest as en, type PreviewBuyerPickupConfirmationEmailResponse as eo, type PreviewShippingConfirmationEmailRequest as ep, type PreviewShippingConfirmationEmailResponse as eq, type PreviewResendDownloadLinksEmailRequest as er, type PreviewResendDownloadLinksEmailResponse as es, type MetaSiteSpecialEvent as et, type MetaSiteSpecialEventPayloadOneOf as eu, type Asset as ev, type SiteCreated as ew, type SiteTransferred as ex, type SiteDeleted as ey, type DeleteContext as ez, type CaptureAuthorizedPaymentsApplicationErrors as f, type LineItemRefundSummary as f$, type AddToAutomationMigrationPopulationRequest as f0, type AddToAutomationMigrationPopulationResponse as f1, type IsInAutomationMigrationPopulationRequest as f2, type IsInAutomationMigrationPopulationResponse as f3, type PreparePaymentCollectionRequest as f4, type RedirectUrls as f5, type DelayedCaptureSettings as f6, type Duration as f7, type GetPaymentCollectabilityStatusRequest as f8, type RecordManuallyCollectedPaymentRequest as f9, type RestockInfo as fA, type RestockItem as fB, type TriggerRefundResponse as fC, type OrderTransactions as fD, type Payment as fE, type PaymentPaymentDetailsOneOf as fF, type PaymentReceiptInfoOneOf as fG, type RegularPaymentDetails as fH, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fI, type CreditCardPaymentMethodDetails as fJ, type AuthorizationDetails as fK, type AuthorizationCapture as fL, type AuthorizationActionFailureDetails as fM, type AuthorizationVoid as fN, type V1ScheduledAction as fO, type Chargeback as fP, type PaymentMethodName as fQ, type GiftCardPaymentDetails as fR, type MembershipPaymentDetails as fS, type WixReceiptInfo as fT, type ExternalReceiptInfo as fU, type CashRoundingDetails as fV, type Refund as fW, type RefundTransaction as fX, type RefundStatusInfo as fY, type AggregatedRefundSummary as fZ, type RefundItemsBreakdown as f_, type UserDefinedPaymentMethodName as fa, type UserDefinedPaymentMethodNameKindOneOf as fb, type RecordManuallyCollectedPaymentResponse as fc, type MarkOrderAsPaidRequest as fd, type MarkOrderAsPaidResponse as fe, type BulkMarkOrdersAsPaidRequest as ff, type BulkMarkOrdersAsPaidResponse as fg, type BulkOrderResult as fh, type ItemMetadata as fi, type ApplicationError as fj, type BulkActionMetadata as fk, type GetRefundabilityStatusRequest as fl, type GetRefundabilityStatusResponse as fm, type Refundability as fn, type RefundabilityAdditionalRefundabilityInfoOneOf as fo, type CreatePaymentGatewayOrderRequest as fp, type ChargedBy as fq, type CreatePaymentGatewayOrderResponse as fr, type ChargeMembershipsRequest as fs, type MembershipChargeItem as ft, type MembershipName as fu, type ServiceProperties as fv, type ChargeMembershipsResponse as fw, type TriggerRefundRequest as fx, type PaymentRefund as fy, type RefundSideEffects as fz, type GetOrderApplicationErrors as g, type UpdateBillingContactDetailsRequest as g$, type CalculateRefundRequest as g0, type CalculateRefundItemRequest as g1, type CalculateRefundResponse as g2, type CalculateRefundItemResponse as g3, type VoidAuthorizedPaymentsRequest as g4, type CaptureAuthorizedPaymentsRequest as g5, type ChargeSavedPaymentMethodRequest as g6, type ChargeSavedPaymentMethodResponse as g7, type DiffmatokyPayload as g8, type ErrorInformation as g9, type DraftOrderDiffs as gA, type DraftOrderDiffsShippingUpdateInfoOneOf as gB, type DraftOrderDiffsBuyerUpdateInfoOneOf as gC, type DraftOrderDiffsBillingUpdateInfoOneOf as gD, type DraftOrderDiffsRecipientUpdateInfoOneOf as gE, type V1LineItemDelta as gF, type V1LineItemDeltaDeltaOneOf as gG, type CommitDeltasResponse as gH, type ArchiveOrderRequest as gI, type ArchiveOrderResponse as gJ, type BulkArchiveOrdersRequest as gK, type BulkArchiveOrdersResponse as gL, type BulkArchiveOrdersByFilterRequest as gM, type BulkArchiveOrdersByFilterResponse as gN, type UnArchiveOrderRequest as gO, type UnArchiveOrderResponse as gP, type BulkUnArchiveOrdersRequest as gQ, type BulkUnArchiveOrdersResponse as gR, type BulkUnArchiveOrdersByFilterRequest as gS, type BulkUnArchiveOrdersByFilterResponse as gT, type UpdateBuyerInfoRequest as gU, type BuyerInfoUpdate as gV, type UpdateBuyerInfoResponse as gW, type UpdateBuyerEmailRequest as gX, type UpdateBuyerEmailResponse as gY, type UpdateOrderShippingAddressRequest as gZ, type UpdateOrderShippingAddressResponse as g_, type GetOrderRequest as ga, type GetOrderResponse as gb, type InternalQueryOrdersRequest as gc, type PlatformQuery as gd, type PlatformQueryPagingMethodOneOf as ge, type Sorting as gf, type PlatformPaging as gg, type CursorPaging as gh, type InternalQueryOrdersResponse as gi, type PlatformPagingMetadata as gj, type Cursors as gk, type QueryOrderRequest as gl, type QueryOrderResponse as gm, type SearchOrdersRequest as gn, type CursorSearch as go, type CursorSearchPagingMethodOneOf as gp, type CursorPagingMetadata as gq, type CreateOrderRequest as gr, type OrderCreationSettings as gs, type OrderCreationSettingsEditableByOneOf as gt, type OrderCreateNotifications as gu, type CreateOrderResponse as gv, type UpdateOrderRequest as gw, type UpdateOrderResponse as gx, type BulkUpdateOrdersRequest as gy, type CommitDeltasRequest as gz, type OrderSearch as h, type V1BulkMarkOrdersAsPaidRequest as h$, type UpdateBillingContactDetailsResponse as h0, type UpdateOrderLineItemRequest as h1, type UpdateOrderLineItemResponse as h2, type UpdateOrderLineItemsRequest as h3, type MaskedOrderLineItem as h4, type UpdateOrderLineItemsResponse as h5, type AddInternalActivityRequest as h6, type InternalActivity as h7, type InternalActivityContentOneOf as h8, type OrderPlaced as h9, type DeleteActivityRequest as hA, type DeleteActivityResponse as hB, type UpdateLineItemsDescriptionLinesRequest as hC, type LineItemUpdate as hD, type UpdateLineItemsDescriptionLinesResponse as hE, type MarkOrderAsSeenByHumanRequest as hF, type MarkOrderAsSeenByHumanResponse as hG, type CancelOrderRequest as hH, type UpdateOrderStatusRequest as hI, type UpdateOrderStatusResponse as hJ, type MarkAsFulfilledRequest as hK, type MarkAsFulfilledResponse as hL, type BulkMarkAsFulfilledRequest as hM, type BulkMarkAsFulfilledResponse as hN, type BulkMarkAsFulfilledByFilterRequest as hO, type BulkMarkAsFulfilledByFilterResponse as hP, type MarkAsUnfulfilledRequest as hQ, type MarkAsUnfulfilledResponse as hR, type BulkMarkAsUnfulfilledRequest as hS, type BulkMarkAsUnfulfilledResponse as hT, type BulkMarkAsUnfulfilledByFilterRequest as hU, type BulkMarkAsUnfulfilledByFilterResponse as hV, type BulkSetBusinessLocationRequest as hW, type BulkSetBusinessLocationResponse as hX, type BulkSetBusinessLocationResult as hY, type V1MarkOrderAsPaidRequest as hZ, type V1MarkOrderAsPaidResponse as h_, type OrderPaid as ha, type OrderFulfilled as hb, type OrderNotFulfilled as hc, type OrderCanceled as hd, type DownloadLinkSent as he, type TrackingNumberAdded as hf, type TrackingNumberEdited as hg, type TrackingLinkAdded as hh, type ShippingConfirmationEmailSent as hi, type InvoiceAdded as hj, type InvoiceSent as hk, type FulfillerEmailSent as hl, type ShippingAddressEdited as hm, type EmailEdited as hn, type PickupReadyEmailSent as ho, type OrderPartiallyPaid as hp, type OrderPending as hq, type OrderRejected as hr, type AddInternalActivityResponse as hs, type AddActivityRequest as ht, type PublicActivity as hu, type PublicActivityContentOneOf as hv, type AddActivityResponse as hw, type AddActivitiesRequest as hx, type UpdateActivityRequest as hy, type UpdateActivityResponse as hz, type CreateOrderOptions as i, type RecordManuallyCollectedPaymentOptions as i$, type V1BulkMarkOrdersAsPaidResponse as i0, type V1CreatePaymentGatewayOrderRequest as i1, type V1CreatePaymentGatewayOrderResponse as i2, type GetShipmentsRequest as i3, type GetShipmentsResponse as i4, type AggregateOrdersRequest as i5, type AggregateOrdersResponse as i6, type DecrementItemsQuantityRequest as i7, type DecrementData as i8, type DecrementItemsQuantityResponse as i9, type Subdivision as iA, type StandardDetails as iB, type InvoiceDates as iC, type LineItems as iD, type LineItem as iE, type BigDecimalWrapper as iF, type LineItemTax as iG, type Source as iH, type LineItemMetaData as iI, type Locale as iJ, type TotalPrice as iK, type ItemizedFee as iL, type Discount as iM, type DiscountOneDiscountTypeOneOf as iN, type CalculatedTaxes as iO, type CalculatedTax as iP, type Payments as iQ, type InvoicesPayment as iR, type MetaData as iS, type InvoiceDynamicPriceTotals as iT, type CustomFieldValue as iU, type Value as iV, type Deposit as iW, type BaseEventMetadata as iX, type EventMetadata as iY, type AccountInfoMetadata as iZ, type SetOrderNumberCounterOptions as i_, type BulkUpdateOrderTagsRequest as ia, type TagsTags as ib, type TagsTagList as ic, type BulkUpdateOrderTagsResult as id, type SendOrderUpdatedDomainEventRequest as ie, type SendOrderUpdatedDomainEventResponse as ig, type Task as ih, type TaskKey as ii, type TaskAction as ij, type TaskActionActionOneOf as ik, type Complete as il, type Cancel as im, type Reschedule as io, type InvoiceSentEvent as ip, type IdAndVersion as iq, type InvoiceFields as ir, type Customer as is, type Email as it, type QuotesAddress as iu, type AddressDescription as iv, type Phone as iw, type Company as ix, type CommonAddress as iy, type CommonAddressStreetOneOf as iz, type CreateOrderApplicationErrors as j, type SortOrderWithLiterals as j$, type PaymentCollectionMarkOrderAsPaidOptions as j0, type PaymentCollectionCreatePaymentGatewayOrderOptions as j1, type ChargeMembershipsOptions as j2, type TriggerRefundOptions as j3, type OrderSearchSpec as j4, type UpdateOrderLineItemIdentifiers as j5, type UpdateOrderLineItem as j6, type UpdateActivityIdentifiers as j7, type DeleteActivityIdentifiers as j8, type AggregateOrdersOptions as j9, type DeltaPaymentOptionTypeWithLiterals as jA, type InventoryActionWithLiterals as jB, type WebhookIdentityTypeWithLiterals as jC, type VersioningModeWithLiterals as jD, type PreviewEmailTypeWithLiterals as jE, type StateWithLiterals as jF, type SiteCreatedContextWithLiterals as jG, type NamespaceWithLiterals as jH, type DeleteStatusWithLiterals as jI, type OriginWithLiterals as jJ, type ScheduledActionWithLiterals as jK, type DurationUnitWithLiterals as jL, type PaymentCollectabilityStatusWithLiterals as jM, type PredefinedPaymentMethodWithLiterals as jN, type RefundableStatusWithLiterals as jO, type NonRefundableReasonWithLiterals as jP, type ManuallyRefundableReasonWithLiterals as jQ, type RestockTypeWithLiterals as jR, type TransactionStatusWithLiterals as jS, type AuthorizationCaptureStatusWithLiterals as jT, type AuthorizationVoidStatusWithLiterals as jU, type ReasonWithLiterals as jV, type ActionTypeWithLiterals as jW, type ChargebackStatusWithLiterals as jX, type MembershipPaymentStatusWithLiterals as jY, type PaymentStatusWithLiterals as jZ, type RefundStatusWithLiterals as j_, utils as ja, type DescriptionLineTypeWithLiterals as jb, type DimensionsUnitWithLiterals as jc, type ItemTypePresetWithLiterals as jd, type PaymentOptionTypeWithLiterals as je, type JurisdictionTypeWithLiterals as jf, type SubscriptionFrequencyWithLiterals as jg, type AdjustmentTypeWithLiterals as jh, type TaxableAddressTypeWithLiterals as ji, type PaymentStatusEnumPaymentStatusWithLiterals as jj, type FulfillmentStatusWithLiterals as jk, type WeightUnitWithLiterals as jl, type VatTypeWithLiterals as jm, type PickupMethodWithLiterals as jn, type OrderStatusWithLiterals as jo, type DiscountTypeWithLiterals as jp, type DiscountReasonWithLiterals as jq, type LineItemQuantityChangeTypeWithLiterals as jr, type ActivityTypeWithLiterals as js, type OrderActivityTypeEnumActivityTypeWithLiterals as jt, type AttributionSourceWithLiterals as ju, type ChannelTypeWithLiterals as jv, type AdditionalFeeSourceWithLiterals as jw, type OrderActionTypeWithLiterals as jx, type SpecificItemsCouponBehaviorWithLiterals as jy, type ChargeTypeWithLiterals as jz, type UpdateOrderApplicationErrors as k, type OrderApprovalStrategyWithLiterals as k0, type PlacementWithLiterals as k1, type SubdivisionTypeWithLiterals as k2, type SourceTypeWithLiterals as k3, type CustomFieldGroupWithLiterals as k4, type ValueTypeWithLiterals as k5, type DepositTypeWithLiterals as k6, type InvoiceStatusWithLiterals as k7, type RecordManuallyCollectedPaymentApplicationErrors as k8, type PaymentCollectionMarkOrderAsPaidApplicationErrors as k9, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as ka, type TriggerRefundApplicationErrors as kb, type UpdateOrderStatusApplicationErrors as kc, type CommonSearchWithEntityContext as kd, onOrderApproved as ke, onOrderCanceled as kf, onOrderCommitted as kg, onOrderCreated as kh, onOrderFulfilled as ki, onOrderPaymentStatusUpdated as kj, onOrderUpdated as kk, preparePaymentCollection as kl, getPaymentCollectabilityStatus as km, voidAuthorizedPayments as kn, captureAuthorizedPayments as ko, getOrder as kp, createOrder as kq, updateOrder as kr, bulkUpdateOrders as ks, addActivities as kt, cancelOrder as ku, bulkUpdateOrderTags as kv, type BulkUpdateOrdersResponse as l, type AddActivitiesResponse as m, type CancelOrderOptions as n, type CancelOrderResponse as o, type CancelOrderApplicationErrors as p, type BulkUpdateOrderTagsOptions as q, type BulkUpdateOrderTagsResponse as r, type OrderApprovedEnvelope as s, type OrderCanceledEnvelope as t, type OrderCommittedEnvelope as u, type OrderCreatedEnvelope as v, type OrderFulfilledEnvelope as w, type OrderPaymentStatusUpdatedEnvelope as x, type OrderUpdatedEnvelope as y, DimensionsUnit as z };
|