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