@wix/auto_sdk_ecom_orders 1.0.318 → 1.0.319
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-cwJXByV0.d.ts → ecom-v1-order-orders.universal-DkuT45RM.d.ts} +1694 -1684
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +80 -80
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +80 -80
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1694 -1684
- package/build/cjs/meta.js +80 -80
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-cwJXByV0.d.mts → ecom-v1-order-orders.universal-DkuT45RM.d.mts} +1694 -1684
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs +80 -80
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +80 -80
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1694 -1684
- package/build/es/meta.mjs +80 -80
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-CaNCF4JV.d.ts → ecom-v1-order-orders.universal-CaKWoBtD.d.ts} +1830 -1820
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/meta.d.ts +1830 -1820
- package/build/internal/es/{ecom-v1-order-orders.universal-CaNCF4JV.d.mts → ecom-v1-order-orders.universal-CaKWoBtD.d.mts} +1830 -1820
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/meta.d.mts +1830 -1820
- package/package.json +2 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ex as ImportOrderRequest$1, I as ImportOrderResponse$1, ey as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ez as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1,
|
|
1
|
+
import { ex as ImportOrderRequest$1, I as ImportOrderResponse$1, ey as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ez as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fU as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fY as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fZ as RecordManuallyCollectedPaymentRequest$1, g0 as RecordManuallyCollectedPaymentResponse$1, g1 as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, g2 as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, g7 as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, ga as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, gc as ChargeMembershipsRequest$1, gf as ChargeMembershipsResponse$1, gg as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gU as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gV as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h1 as GetOrderRequest$1, h2 as GetOrderResponse$1, he as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hi as CreateOrderRequest$1, hm as CreateOrderResponse$1, hn as UpdateOrderRequest$1, ho as UpdateOrderResponse$1, hp as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hU as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ik as AddActivityRequest$1, N as AddActivityResponse$1, im as AddActivitiesRequest$1, W as AddActivitiesResponse$1, io as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ip as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iv as CancelOrderRequest$1, a0 as CancelOrderResponse$1, iw as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iU as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iY as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-CaKWoBtD.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -950,10 +950,16 @@ interface DigitalFile {
|
|
|
950
950
|
interface SubscriptionInfo {
|
|
951
951
|
/**
|
|
952
952
|
* Subscription ID.
|
|
953
|
+
*
|
|
954
|
+
* For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
|
|
955
|
+
* To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
|
|
953
956
|
* @format GUID
|
|
954
957
|
*/
|
|
955
958
|
id?: string | null;
|
|
956
|
-
/**
|
|
959
|
+
/**
|
|
960
|
+
* Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
|
|
961
|
+
* When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
|
|
962
|
+
*/
|
|
957
963
|
cycleNumber?: number;
|
|
958
964
|
/**
|
|
959
965
|
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
@@ -1029,7 +1035,7 @@ interface SubscriptionDescription {
|
|
|
1029
1035
|
translated?: string | null;
|
|
1030
1036
|
}
|
|
1031
1037
|
interface SubscriptionSettings {
|
|
1032
|
-
/** Frequency of
|
|
1038
|
+
/** Frequency unit of the billing cycle. */
|
|
1033
1039
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
1034
1040
|
/**
|
|
1035
1041
|
* Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
|
|
@@ -1037,16 +1043,20 @@ interface SubscriptionSettings {
|
|
|
1037
1043
|
* @max 3650
|
|
1038
1044
|
*/
|
|
1039
1045
|
interval?: number | null;
|
|
1040
|
-
/** Whether subscription
|
|
1046
|
+
/** Whether the subscription renews automatically at the end of each billing cycle. */
|
|
1041
1047
|
autoRenewal?: boolean;
|
|
1042
1048
|
/**
|
|
1043
|
-
* Number of billing cycles before subscription ends. Ignored
|
|
1049
|
+
* Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
|
|
1044
1050
|
* @min 1
|
|
1045
1051
|
*/
|
|
1046
1052
|
billingCycles?: number | null;
|
|
1047
|
-
/** Whether
|
|
1053
|
+
/** Whether the buyer can cancel the subscription. */
|
|
1048
1054
|
enableCustomerCancellation?: boolean;
|
|
1049
|
-
/**
|
|
1055
|
+
/**
|
|
1056
|
+
* Free trial period before the first billing cycle starts.
|
|
1057
|
+
*
|
|
1058
|
+
* Returned only when the subscription has a free trial.
|
|
1059
|
+
*/
|
|
1050
1060
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
1051
1061
|
/**
|
|
1052
1062
|
* The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
|
|
@@ -1075,7 +1085,7 @@ declare enum SubscriptionFrequency {
|
|
|
1075
1085
|
/** @enumType */
|
|
1076
1086
|
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
1077
1087
|
interface FreeTrialPeriod {
|
|
1078
|
-
/** Frequency of
|
|
1088
|
+
/** Frequency unit of the free trial period. */
|
|
1079
1089
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
1080
1090
|
/**
|
|
1081
1091
|
* Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
|
|
@@ -4765,2328 +4775,2328 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
4765
4775
|
*/
|
|
4766
4776
|
jobId?: string;
|
|
4767
4777
|
}
|
|
4768
|
-
interface
|
|
4778
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
4769
4779
|
/** @format GUID */
|
|
4770
|
-
|
|
4780
|
+
orderId?: string;
|
|
4781
|
+
}
|
|
4782
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
4783
|
+
}
|
|
4784
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
4771
4785
|
/**
|
|
4772
4786
|
* @minLength 1
|
|
4773
4787
|
* @maxLength 100
|
|
4774
|
-
* @maxSize 100
|
|
4775
4788
|
*/
|
|
4776
|
-
|
|
4789
|
+
orderId?: string;
|
|
4777
4790
|
}
|
|
4778
|
-
interface
|
|
4791
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
4779
4792
|
}
|
|
4780
|
-
interface
|
|
4781
|
-
/** @format GUID */
|
|
4782
|
-
metasiteId?: string;
|
|
4793
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
4783
4794
|
/**
|
|
4784
4795
|
* @minLength 1
|
|
4785
4796
|
* @maxLength 100
|
|
4786
4797
|
*/
|
|
4787
4798
|
orderId?: string;
|
|
4788
4799
|
}
|
|
4789
|
-
interface
|
|
4800
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
4801
|
+
}
|
|
4802
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
4803
|
+
/**
|
|
4804
|
+
* IDs of orders to send pickup emails for.
|
|
4805
|
+
* @minSize 1
|
|
4806
|
+
* @maxSize 300
|
|
4807
|
+
*/
|
|
4808
|
+
orderIds?: string[];
|
|
4809
|
+
}
|
|
4810
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
4811
|
+
}
|
|
4812
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
4790
4813
|
/**
|
|
4791
|
-
* Ecom order ID.
|
|
4792
4814
|
* @minLength 1
|
|
4793
4815
|
* @maxLength 100
|
|
4794
4816
|
*/
|
|
4795
|
-
|
|
4796
|
-
|
|
4797
|
-
|
|
4817
|
+
orderId?: string;
|
|
4818
|
+
}
|
|
4819
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
4820
|
+
}
|
|
4821
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
4798
4822
|
/**
|
|
4799
|
-
*
|
|
4800
|
-
*
|
|
4801
|
-
*
|
|
4823
|
+
* IDs of orders to send pickup emails for.
|
|
4824
|
+
* @minSize 1
|
|
4825
|
+
* @maxSize 300
|
|
4802
4826
|
*/
|
|
4803
|
-
|
|
4827
|
+
orderIds?: string[];
|
|
4828
|
+
}
|
|
4829
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
4830
|
+
}
|
|
4831
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
4804
4832
|
/**
|
|
4805
|
-
*
|
|
4806
|
-
*
|
|
4807
|
-
* @deprecated Whether to delay capture of the payment.
|
|
4808
|
-
* Default: false
|
|
4809
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4810
|
-
* @targetRemovalDate 2024-09-30
|
|
4833
|
+
* @minLength 1
|
|
4834
|
+
* @maxLength 100
|
|
4811
4835
|
*/
|
|
4812
|
-
|
|
4836
|
+
orderId?: string;
|
|
4837
|
+
}
|
|
4838
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
4839
|
+
}
|
|
4840
|
+
interface SendCancelRefundEmailRequest {
|
|
4813
4841
|
/**
|
|
4814
|
-
*
|
|
4815
|
-
*
|
|
4816
|
-
* @
|
|
4842
|
+
* The ID of order that is canceled/refunded
|
|
4843
|
+
* @minLength 1
|
|
4844
|
+
* @maxLength 100
|
|
4817
4845
|
*/
|
|
4818
|
-
|
|
4846
|
+
orderId?: string;
|
|
4819
4847
|
/**
|
|
4820
|
-
*
|
|
4821
|
-
* @
|
|
4848
|
+
* Personal note added to the email (optional)
|
|
4849
|
+
* @minLength 1
|
|
4850
|
+
* @maxLength 1000
|
|
4822
4851
|
*/
|
|
4823
|
-
|
|
4824
|
-
/**
|
|
4825
|
-
|
|
4826
|
-
}
|
|
4827
|
-
interface RedirectUrls {
|
|
4852
|
+
customMessage?: string | null;
|
|
4853
|
+
/** Refund amount */
|
|
4854
|
+
refundAmount?: Price;
|
|
4828
4855
|
/**
|
|
4829
|
-
*
|
|
4830
|
-
* @format
|
|
4856
|
+
* Refund ID. (Optional)
|
|
4857
|
+
* @format GUID
|
|
4831
4858
|
*/
|
|
4832
|
-
|
|
4859
|
+
refundId?: string | null;
|
|
4860
|
+
}
|
|
4861
|
+
interface SendCancelRefundEmailResponse {
|
|
4862
|
+
}
|
|
4863
|
+
interface SendRefundEmailRequest {
|
|
4833
4864
|
/**
|
|
4834
|
-
*
|
|
4835
|
-
* @format
|
|
4865
|
+
* The ID of order that is refunded
|
|
4866
|
+
* @format GUID
|
|
4836
4867
|
*/
|
|
4837
|
-
|
|
4868
|
+
orderId?: string;
|
|
4838
4869
|
/**
|
|
4839
|
-
*
|
|
4840
|
-
* @format
|
|
4870
|
+
* Refund ID
|
|
4871
|
+
* @format GUID
|
|
4841
4872
|
*/
|
|
4842
|
-
|
|
4873
|
+
refundId?: string;
|
|
4843
4874
|
/**
|
|
4844
|
-
*
|
|
4845
|
-
* @
|
|
4875
|
+
* Personal note added to the email (optional)
|
|
4876
|
+
* @minLength 1
|
|
4877
|
+
* @maxLength 1000
|
|
4846
4878
|
*/
|
|
4847
|
-
|
|
4879
|
+
customMessage?: string | null;
|
|
4848
4880
|
}
|
|
4849
|
-
interface
|
|
4850
|
-
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4851
|
-
scheduledAction?: ScheduledActionWithLiterals;
|
|
4852
|
-
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4853
|
-
delayDuration?: Duration;
|
|
4881
|
+
interface SendRefundEmailResponse {
|
|
4854
4882
|
}
|
|
4855
|
-
|
|
4856
|
-
/**
|
|
4857
|
-
|
|
4858
|
-
/**
|
|
4859
|
-
|
|
4883
|
+
interface SendFulfillmentEmailRequest {
|
|
4884
|
+
/** @format GUID */
|
|
4885
|
+
orderId?: string;
|
|
4886
|
+
/** @format GUID */
|
|
4887
|
+
fulfillerId?: string;
|
|
4860
4888
|
}
|
|
4861
|
-
|
|
4862
|
-
|
|
4863
|
-
interface
|
|
4889
|
+
interface SendFulfillmentEmailResponse {
|
|
4890
|
+
}
|
|
4891
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
4864
4892
|
/**
|
|
4865
|
-
*
|
|
4866
|
-
* @
|
|
4893
|
+
* @minLength 1
|
|
4894
|
+
* @maxLength 100
|
|
4867
4895
|
*/
|
|
4868
|
-
|
|
4869
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4870
|
-
unit?: DurationUnitWithLiterals;
|
|
4896
|
+
orderId?: string;
|
|
4871
4897
|
}
|
|
4872
|
-
|
|
4873
|
-
|
|
4874
|
-
|
|
4875
|
-
|
|
4898
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
4899
|
+
}
|
|
4900
|
+
interface PreviewEmailByTypeRequest {
|
|
4901
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
4902
|
+
}
|
|
4903
|
+
declare enum PreviewEmailType {
|
|
4904
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
4905
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
4906
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
4907
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4876
4908
|
}
|
|
4877
4909
|
/** @enumType */
|
|
4878
|
-
type
|
|
4879
|
-
interface
|
|
4880
|
-
|
|
4881
|
-
paymentGatewayOrderId?: string;
|
|
4910
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
4911
|
+
interface PreviewEmailByTypeResponse {
|
|
4912
|
+
emailPreview?: string;
|
|
4882
4913
|
}
|
|
4883
|
-
interface
|
|
4914
|
+
interface PreviewRefundEmailRequest {
|
|
4884
4915
|
/**
|
|
4885
|
-
* Ecom order ID.
|
|
4886
4916
|
* @minLength 1
|
|
4887
4917
|
* @maxLength 100
|
|
4888
4918
|
*/
|
|
4889
|
-
|
|
4890
|
-
|
|
4891
|
-
|
|
4892
|
-
/**
|
|
4893
|
-
|
|
4894
|
-
/** Collectable order amount */
|
|
4895
|
-
amount?: Price;
|
|
4919
|
+
orderId?: string;
|
|
4920
|
+
/** Refund amount */
|
|
4921
|
+
refundAmount?: Price;
|
|
4922
|
+
/** Refund business details */
|
|
4923
|
+
details?: RefundDetails;
|
|
4896
4924
|
/**
|
|
4897
|
-
*
|
|
4898
|
-
* @
|
|
4925
|
+
* Personal note added to the email (optional)
|
|
4926
|
+
* @minLength 1
|
|
4927
|
+
* @maxLength 1000
|
|
4899
4928
|
*/
|
|
4900
|
-
|
|
4929
|
+
customMessage?: string | null;
|
|
4901
4930
|
/**
|
|
4902
|
-
*
|
|
4903
|
-
* @
|
|
4931
|
+
* Refund ID. (Optional)
|
|
4932
|
+
* @format GUID
|
|
4904
4933
|
*/
|
|
4905
|
-
|
|
4906
|
-
}
|
|
4907
|
-
declare enum PaymentCollectabilityStatus {
|
|
4908
|
-
UNKNOWN = "UNKNOWN",
|
|
4909
|
-
COLLECTABLE = "COLLECTABLE",
|
|
4910
|
-
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4911
|
-
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4912
|
-
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4913
|
-
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4914
|
-
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4915
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4916
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4917
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4918
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4919
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
4920
|
-
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
4934
|
+
refundId?: string | null;
|
|
4921
4935
|
}
|
|
4922
|
-
/**
|
|
4923
|
-
|
|
4924
|
-
interface RecordManuallyCollectedPaymentRequest {
|
|
4936
|
+
/** Business model of a refund request */
|
|
4937
|
+
interface RefundDetails {
|
|
4925
4938
|
/**
|
|
4926
|
-
* Order
|
|
4927
|
-
* @
|
|
4928
|
-
* @maxLength 100
|
|
4939
|
+
* Order line item IDs and quantities that were refunded.
|
|
4940
|
+
* @maxSize 300
|
|
4929
4941
|
*/
|
|
4930
|
-
|
|
4931
|
-
/**
|
|
4932
|
-
|
|
4942
|
+
items?: RefundItem[];
|
|
4943
|
+
/** Whether the shipping fee was also refunded. */
|
|
4944
|
+
shippingIncluded?: boolean;
|
|
4933
4945
|
/**
|
|
4934
|
-
*
|
|
4935
|
-
*
|
|
4936
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4937
|
-
* @internal
|
|
4946
|
+
* Reason for the refund, provided by customer (optional).
|
|
4947
|
+
* @maxLength 200
|
|
4938
4948
|
*/
|
|
4939
|
-
|
|
4940
|
-
}
|
|
4941
|
-
/**
|
|
4942
|
-
* User-defined payment method name.
|
|
4943
|
-
* Allows specifying either a predefined type or a custom name.
|
|
4944
|
-
*/
|
|
4945
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4946
|
-
/** Predefined payment method. */
|
|
4947
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4949
|
+
reason?: string | null;
|
|
4948
4950
|
/**
|
|
4949
|
-
*
|
|
4950
|
-
*
|
|
4951
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4952
|
-
* @minLength 1
|
|
4953
|
-
* @maxLength 150
|
|
4951
|
+
* Line items that were refunded.
|
|
4952
|
+
* @maxSize 300
|
|
4954
4953
|
*/
|
|
4955
|
-
|
|
4956
|
-
}
|
|
4957
|
-
/** @oneof */
|
|
4958
|
-
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
4959
|
-
/** Predefined payment method. */
|
|
4960
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4954
|
+
lineItems?: LineItemRefund[];
|
|
4961
4955
|
/**
|
|
4962
|
-
*
|
|
4963
|
-
*
|
|
4964
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4965
|
-
* @minLength 1
|
|
4966
|
-
* @maxLength 150
|
|
4956
|
+
* Additional fees that were refunded.
|
|
4957
|
+
* @maxSize 100
|
|
4967
4958
|
*/
|
|
4968
|
-
|
|
4969
|
-
|
|
4970
|
-
|
|
4971
|
-
declare enum PredefinedPaymentMethod {
|
|
4972
|
-
/** Cash payment. */
|
|
4973
|
-
CASH = "CASH",
|
|
4974
|
-
/** Bank transfer. */
|
|
4975
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
4976
|
-
/** Payment by check. */
|
|
4977
|
-
CHECK = "CHECK"
|
|
4978
|
-
}
|
|
4979
|
-
/** @enumType */
|
|
4980
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
4981
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
4959
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
4960
|
+
/** Shipping amount that was refunded. */
|
|
4961
|
+
shipping?: ShippingRefund;
|
|
4982
4962
|
}
|
|
4983
|
-
interface
|
|
4963
|
+
interface RefundItem {
|
|
4984
4964
|
/**
|
|
4985
|
-
*
|
|
4986
|
-
* @
|
|
4987
|
-
* @maxLength 100
|
|
4965
|
+
* Line item ID the refunded line item.
|
|
4966
|
+
* @format GUID
|
|
4988
4967
|
*/
|
|
4989
|
-
|
|
4968
|
+
lineItemId?: string;
|
|
4990
4969
|
/**
|
|
4991
|
-
*
|
|
4992
|
-
*
|
|
4993
|
-
*
|
|
4994
|
-
* @internal
|
|
4970
|
+
* Line item quantity refunded.
|
|
4971
|
+
* @min 1
|
|
4972
|
+
* @max 100000
|
|
4995
4973
|
*/
|
|
4996
|
-
|
|
4997
|
-
}
|
|
4998
|
-
interface MarkOrderAsPaidResponse {
|
|
4999
|
-
/** Updated order. */
|
|
5000
|
-
order?: Order;
|
|
4974
|
+
quantity?: number;
|
|
5001
4975
|
}
|
|
5002
|
-
interface
|
|
4976
|
+
interface LineItemRefund {
|
|
5003
4977
|
/**
|
|
5004
|
-
*
|
|
5005
|
-
* @
|
|
5006
|
-
* @
|
|
5007
|
-
* @minLength 1
|
|
5008
|
-
* @maxLength 100
|
|
4978
|
+
* Line item ID.
|
|
4979
|
+
* @format GUID
|
|
4980
|
+
* @immutable
|
|
5009
4981
|
*/
|
|
5010
|
-
|
|
5011
|
-
}
|
|
5012
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
4982
|
+
lineItemId?: string;
|
|
5013
4983
|
/**
|
|
5014
|
-
*
|
|
5015
|
-
*
|
|
4984
|
+
* Refund quantity.
|
|
4985
|
+
* @min 1
|
|
4986
|
+
* @max 100000
|
|
4987
|
+
* @immutable
|
|
5016
4988
|
*/
|
|
5017
|
-
|
|
5018
|
-
/** Bulk action metadata. */
|
|
5019
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
4989
|
+
quantity?: number;
|
|
5020
4990
|
}
|
|
5021
|
-
interface
|
|
5022
|
-
/** Item metadata. */
|
|
5023
|
-
itemMetadata?: ItemMetadata;
|
|
4991
|
+
interface AdditionalFeeRefund {
|
|
5024
4992
|
/**
|
|
5025
|
-
*
|
|
5026
|
-
*
|
|
5027
|
-
*
|
|
4993
|
+
* Additional fee ID.
|
|
4994
|
+
* @format GUID
|
|
4995
|
+
* @immutable
|
|
5028
4996
|
*/
|
|
5029
|
-
|
|
5030
|
-
}
|
|
5031
|
-
interface ItemMetadata {
|
|
5032
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5033
|
-
id?: string | null;
|
|
5034
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5035
|
-
originalIndex?: number;
|
|
5036
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5037
|
-
success?: boolean;
|
|
5038
|
-
/** Details about the error in case of failure. */
|
|
5039
|
-
error?: ApplicationError;
|
|
5040
|
-
}
|
|
5041
|
-
interface ApplicationError {
|
|
5042
|
-
/** Error code. */
|
|
5043
|
-
code?: string;
|
|
5044
|
-
/** Description of the error. */
|
|
5045
|
-
description?: string;
|
|
5046
|
-
/** Data related to the error. */
|
|
5047
|
-
data?: Record<string, any> | null;
|
|
5048
|
-
}
|
|
5049
|
-
interface BulkActionMetadata {
|
|
5050
|
-
/** Number of items that were successfully processed. */
|
|
5051
|
-
totalSuccesses?: number;
|
|
5052
|
-
/** Number of items that couldn't be processed. */
|
|
5053
|
-
totalFailures?: number;
|
|
5054
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5055
|
-
undetailedFailures?: number;
|
|
5056
|
-
}
|
|
5057
|
-
interface GetRefundabilityStatusRequest {
|
|
4997
|
+
additionalFeeId?: string;
|
|
5058
4998
|
/**
|
|
5059
|
-
*
|
|
5060
|
-
* @
|
|
5061
|
-
* @maxLength 100
|
|
4999
|
+
* Refund amount.
|
|
5000
|
+
* @immutable
|
|
5062
5001
|
*/
|
|
5063
|
-
|
|
5002
|
+
amount?: Price;
|
|
5064
5003
|
}
|
|
5065
|
-
interface
|
|
5066
|
-
/**
|
|
5067
|
-
* Refundability details.
|
|
5068
|
-
* @maxSize 300
|
|
5069
|
-
*/
|
|
5070
|
-
refundabilities?: Refundability[];
|
|
5004
|
+
interface ShippingRefund {
|
|
5071
5005
|
/**
|
|
5072
|
-
*
|
|
5073
|
-
* @
|
|
5006
|
+
* Refund amount.
|
|
5007
|
+
* @immutable
|
|
5074
5008
|
*/
|
|
5075
|
-
|
|
5076
|
-
}
|
|
5077
|
-
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5078
|
-
/** Reason why payment is not refundable. */
|
|
5079
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5080
|
-
/** Reason why payment is only refundable manually. */
|
|
5081
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5082
|
-
/** Payment ID. */
|
|
5083
|
-
paymentId?: string;
|
|
5084
|
-
/** Payment refundability status. */
|
|
5085
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
5086
|
-
/** Link to payment provider dashboard. */
|
|
5087
|
-
providerLink?: string | null;
|
|
5088
|
-
}
|
|
5089
|
-
/** @oneof */
|
|
5090
|
-
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5091
|
-
/** Reason why payment is not refundable. */
|
|
5092
|
-
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5093
|
-
/** Reason why payment is only refundable manually. */
|
|
5094
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5095
|
-
}
|
|
5096
|
-
declare enum RefundableStatus {
|
|
5097
|
-
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
5098
|
-
MANUAL = "MANUAL",
|
|
5099
|
-
REFUNDABLE = "REFUNDABLE"
|
|
5100
|
-
}
|
|
5101
|
-
/** @enumType */
|
|
5102
|
-
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
5103
|
-
declare enum NonRefundableReason {
|
|
5104
|
-
NONE = "NONE",
|
|
5105
|
-
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
5106
|
-
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
5107
|
-
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
5108
|
-
NOT_PAID = "NOT_PAID",
|
|
5109
|
-
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5110
|
-
ZERO_PRICE = "ZERO_PRICE",
|
|
5111
|
-
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5112
|
-
PENDING_REFUND = "PENDING_REFUND",
|
|
5113
|
-
FORBIDDEN = "FORBIDDEN",
|
|
5114
|
-
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5115
|
-
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5116
|
-
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5009
|
+
amount?: Price;
|
|
5117
5010
|
}
|
|
5118
|
-
|
|
5119
|
-
|
|
5120
|
-
declare enum ManuallyRefundableReason {
|
|
5121
|
-
EXPIRED = "EXPIRED",
|
|
5122
|
-
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
5123
|
-
OFFLINE = "OFFLINE",
|
|
5124
|
-
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
5011
|
+
interface PreviewRefundEmailResponse {
|
|
5012
|
+
emailPreview?: string;
|
|
5125
5013
|
}
|
|
5126
|
-
|
|
5127
|
-
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
5128
|
-
interface CreatePaymentGatewayOrderRequest {
|
|
5014
|
+
interface PreviewCancelEmailRequest {
|
|
5129
5015
|
/**
|
|
5130
|
-
* Ecom order ID.
|
|
5131
5016
|
* @minLength 1
|
|
5132
5017
|
* @maxLength 100
|
|
5133
5018
|
*/
|
|
5134
|
-
|
|
5135
|
-
/** Information about the user who initiated the payment. */
|
|
5136
|
-
chargedBy?: ChargedBy;
|
|
5137
|
-
/**
|
|
5138
|
-
* Whether to delay capture of the payment.
|
|
5139
|
-
*
|
|
5140
|
-
* Default: false
|
|
5141
|
-
* @internal
|
|
5142
|
-
*/
|
|
5143
|
-
delayedCapture?: boolean;
|
|
5144
|
-
}
|
|
5145
|
-
interface ChargedBy {
|
|
5146
|
-
/**
|
|
5147
|
-
* ID - id of the user who initiated the payment
|
|
5148
|
-
* @format GUID
|
|
5149
|
-
*/
|
|
5150
|
-
id?: string;
|
|
5019
|
+
orderId?: string;
|
|
5151
5020
|
/**
|
|
5152
|
-
*
|
|
5021
|
+
* Personal note added to the email (optional)
|
|
5153
5022
|
* @minLength 1
|
|
5154
|
-
* @maxLength
|
|
5023
|
+
* @maxLength 1000
|
|
5155
5024
|
*/
|
|
5156
|
-
|
|
5025
|
+
customMessage?: string | null;
|
|
5157
5026
|
}
|
|
5158
|
-
interface
|
|
5159
|
-
|
|
5160
|
-
paymentGatewayOrderId?: string;
|
|
5027
|
+
interface PreviewCancelEmailResponse {
|
|
5028
|
+
emailPreview?: string;
|
|
5161
5029
|
}
|
|
5162
|
-
interface
|
|
5030
|
+
interface PreviewCancelRefundEmailRequest {
|
|
5163
5031
|
/**
|
|
5164
|
-
* Order ID.
|
|
5165
5032
|
* @minLength 1
|
|
5166
5033
|
* @maxLength 100
|
|
5167
5034
|
*/
|
|
5168
|
-
|
|
5169
|
-
/**
|
|
5170
|
-
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
5171
|
-
* but a user which is using the membership on behalf of the a member
|
|
5172
|
-
* @format GUID
|
|
5173
|
-
*/
|
|
5174
|
-
memberId: string;
|
|
5175
|
-
/**
|
|
5176
|
-
* List of items to be paid by memberships
|
|
5177
|
-
* @minSize 1
|
|
5178
|
-
* @maxSize 300
|
|
5179
|
-
*/
|
|
5180
|
-
membershipCharges?: MembershipChargeItem[];
|
|
5181
|
-
}
|
|
5182
|
-
interface MembershipChargeItem {
|
|
5035
|
+
orderId?: string;
|
|
5183
5036
|
/**
|
|
5184
|
-
*
|
|
5037
|
+
* Personal note added to the email (optional)
|
|
5185
5038
|
* @minLength 1
|
|
5186
|
-
* @maxLength
|
|
5039
|
+
* @maxLength 1000
|
|
5187
5040
|
*/
|
|
5188
|
-
|
|
5041
|
+
customMessage?: string | null;
|
|
5042
|
+
/** Refund amount */
|
|
5043
|
+
refundAmount?: Price;
|
|
5189
5044
|
/**
|
|
5190
|
-
* ID
|
|
5045
|
+
* Refund ID. (Optional)
|
|
5191
5046
|
* @format GUID
|
|
5192
5047
|
*/
|
|
5193
|
-
|
|
5194
|
-
/** The name of used membership */
|
|
5195
|
-
membershipName?: MembershipName;
|
|
5196
|
-
/** Additional data about this membership */
|
|
5197
|
-
membershipAdditionalData?: Record<string, any> | null;
|
|
5198
|
-
/** Catalog and item reference info. */
|
|
5199
|
-
catalogReference?: CatalogReference;
|
|
5200
|
-
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5201
|
-
serviceProperties?: ServiceProperties;
|
|
5202
|
-
/**
|
|
5203
|
-
* Usually would be the same as catalogReference.catalogItemId
|
|
5204
|
-
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
5205
|
-
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
5206
|
-
* @minLength 1
|
|
5207
|
-
* @maxLength 36
|
|
5208
|
-
*/
|
|
5209
|
-
rootCatalogItemId?: string | null;
|
|
5210
|
-
/**
|
|
5211
|
-
* line item id of Checkout/Order line item
|
|
5212
|
-
* @minLength 1
|
|
5213
|
-
* @maxLength 100
|
|
5214
|
-
*/
|
|
5215
|
-
lineItemId?: string;
|
|
5048
|
+
refundId?: string | null;
|
|
5216
5049
|
}
|
|
5217
|
-
interface
|
|
5218
|
-
|
|
5219
|
-
* Membership name in the site's original language.
|
|
5220
|
-
* @maxLength 100
|
|
5221
|
-
*/
|
|
5222
|
-
original?: string;
|
|
5223
|
-
/**
|
|
5224
|
-
* Membership name translated into the buyer's language.
|
|
5225
|
-
*
|
|
5226
|
-
* Default: The value of `original`
|
|
5227
|
-
* @maxLength 100
|
|
5228
|
-
*/
|
|
5229
|
-
translated?: string | null;
|
|
5050
|
+
interface PreviewCancelRefundEmailResponse {
|
|
5051
|
+
emailPreview?: string;
|
|
5230
5052
|
}
|
|
5231
|
-
interface
|
|
5053
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
5232
5054
|
}
|
|
5233
|
-
interface
|
|
5234
|
-
|
|
5235
|
-
* The order this refund related to
|
|
5236
|
-
* @minLength 1
|
|
5237
|
-
* @maxLength 100
|
|
5238
|
-
*/
|
|
5239
|
-
ecomOrderId: string;
|
|
5240
|
-
/**
|
|
5241
|
-
* Refund operations information
|
|
5242
|
-
* @minSize 1
|
|
5243
|
-
* @maxSize 1
|
|
5244
|
-
*/
|
|
5245
|
-
payments: PaymentRefund[];
|
|
5246
|
-
/** Business model of a refund */
|
|
5247
|
-
details?: RefundDetails;
|
|
5248
|
-
/** Side effect details related to refund */
|
|
5249
|
-
sideEffects?: RefundSideEffects;
|
|
5055
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5056
|
+
emailPreview?: string;
|
|
5250
5057
|
}
|
|
5251
|
-
interface
|
|
5252
|
-
/**
|
|
5253
|
-
* Specific payment within the order to refund
|
|
5254
|
-
* @format GUID
|
|
5255
|
-
*/
|
|
5256
|
-
paymentId?: string;
|
|
5257
|
-
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5258
|
-
amount?: Price;
|
|
5259
|
-
/**
|
|
5260
|
-
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5261
|
-
* 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.
|
|
5262
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5263
|
-
*/
|
|
5264
|
-
externalRefund?: boolean;
|
|
5265
|
-
/**
|
|
5266
|
-
* Gateway refund id. When param is present, new refund is not created.
|
|
5267
|
-
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
5268
|
-
* and all side effects from request will be executed.
|
|
5269
|
-
* @internal
|
|
5270
|
-
* @minLength 1
|
|
5271
|
-
* @maxLength 100
|
|
5272
|
-
*/
|
|
5273
|
-
gatewayRefundId?: string | null;
|
|
5058
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
5274
5059
|
}
|
|
5275
|
-
|
|
5276
|
-
|
|
5277
|
-
/**
|
|
5278
|
-
* Order line item IDs and quantities that were refunded.
|
|
5279
|
-
* @maxSize 300
|
|
5280
|
-
*/
|
|
5281
|
-
items?: RefundItem[];
|
|
5282
|
-
/** Whether the shipping fee was also refunded. */
|
|
5283
|
-
shippingIncluded?: boolean;
|
|
5284
|
-
/**
|
|
5285
|
-
* Reason for the refund, provided by customer (optional).
|
|
5286
|
-
* @maxLength 200
|
|
5287
|
-
*/
|
|
5288
|
-
reason?: string | null;
|
|
5289
|
-
/**
|
|
5290
|
-
* Line items that were refunded.
|
|
5291
|
-
* @maxSize 300
|
|
5292
|
-
*/
|
|
5293
|
-
lineItems?: LineItemRefund[];
|
|
5294
|
-
/**
|
|
5295
|
-
* Additional fees that were refunded.
|
|
5296
|
-
* @maxSize 100
|
|
5297
|
-
*/
|
|
5298
|
-
additionalFees?: AdditionalFeeRefund[];
|
|
5299
|
-
/** Shipping amount that was refunded. */
|
|
5300
|
-
shipping?: ShippingRefund;
|
|
5060
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
5061
|
+
emailPreview?: string;
|
|
5301
5062
|
}
|
|
5302
|
-
interface
|
|
5303
|
-
/**
|
|
5304
|
-
* Line item ID the refunded line item.
|
|
5305
|
-
* @format GUID
|
|
5306
|
-
*/
|
|
5307
|
-
lineItemId?: string;
|
|
5308
|
-
/**
|
|
5309
|
-
* Line item quantity refunded.
|
|
5310
|
-
* @min 1
|
|
5311
|
-
* @max 100000
|
|
5312
|
-
*/
|
|
5313
|
-
quantity?: number;
|
|
5063
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
5314
5064
|
}
|
|
5315
|
-
interface
|
|
5316
|
-
|
|
5317
|
-
* Line item ID.
|
|
5318
|
-
* @format GUID
|
|
5319
|
-
* @immutable
|
|
5320
|
-
*/
|
|
5321
|
-
lineItemId?: string;
|
|
5322
|
-
/**
|
|
5323
|
-
* Refund quantity.
|
|
5324
|
-
* @min 1
|
|
5325
|
-
* @max 100000
|
|
5326
|
-
* @immutable
|
|
5327
|
-
*/
|
|
5328
|
-
quantity?: number;
|
|
5065
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
5066
|
+
emailPreview?: string;
|
|
5329
5067
|
}
|
|
5330
|
-
interface
|
|
5068
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
5069
|
+
}
|
|
5070
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
5071
|
+
emailPreview?: string;
|
|
5072
|
+
}
|
|
5073
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
5074
|
+
}
|
|
5075
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
5076
|
+
emailPreview?: string;
|
|
5077
|
+
}
|
|
5078
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
5079
|
+
/** Emitted on a meta site creation. */
|
|
5080
|
+
siteCreated?: SiteCreated;
|
|
5081
|
+
/** Emitted on a meta site transfer completion. */
|
|
5082
|
+
siteTransferred?: SiteTransferred;
|
|
5083
|
+
/** Emitted on a meta site deletion. */
|
|
5084
|
+
siteDeleted?: SiteDeleted;
|
|
5085
|
+
/** Emitted on a meta site restoration. */
|
|
5086
|
+
siteUndeleted?: SiteUndeleted;
|
|
5087
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5088
|
+
sitePublished?: SitePublished;
|
|
5089
|
+
/** Emitted on a meta site unpublish. */
|
|
5090
|
+
siteUnpublished?: SiteUnpublished;
|
|
5091
|
+
/** Emitted when meta site is marked as template. */
|
|
5092
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5093
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
5094
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5095
|
+
/** Emitted when an application is provisioned (installed). */
|
|
5096
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
5097
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
5098
|
+
serviceRemoved?: ServiceRemoved;
|
|
5099
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
5100
|
+
siteRenamedPayload?: SiteRenamed;
|
|
5101
|
+
/** Emitted when meta site was permanently deleted. */
|
|
5102
|
+
hardDeleted?: SiteHardDeleted;
|
|
5103
|
+
/** Emitted on a namespace change. */
|
|
5104
|
+
namespaceChanged?: NamespaceChanged;
|
|
5105
|
+
/** Emitted when Studio is attached. */
|
|
5106
|
+
studioAssigned?: StudioAssigned;
|
|
5107
|
+
/** Emitted when Studio is detached. */
|
|
5108
|
+
studioUnassigned?: StudioUnassigned;
|
|
5331
5109
|
/**
|
|
5332
|
-
*
|
|
5333
|
-
*
|
|
5334
|
-
*
|
|
5110
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5111
|
+
* the actual URL.
|
|
5112
|
+
*
|
|
5113
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5114
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5335
5115
|
*/
|
|
5336
|
-
|
|
5116
|
+
urlChanged?: SiteUrlChanged;
|
|
5117
|
+
/** Site is marked as PurgedExternally */
|
|
5118
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
5119
|
+
/** Emitted when Odeditor is attached. */
|
|
5120
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
5121
|
+
/** Emitted when Odeditor is detached. */
|
|
5122
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
5123
|
+
/** Emitted when Picasso is attached. */
|
|
5124
|
+
picassoAssigned?: PicassoAssigned;
|
|
5125
|
+
/** Emitted when Picasso is detached. */
|
|
5126
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
5127
|
+
/** Emitted when Wixel is attached. */
|
|
5128
|
+
wixelAssigned?: WixelAssigned;
|
|
5129
|
+
/** Emitted when Wixel is detached. */
|
|
5130
|
+
wixelUnassigned?: WixelUnassigned;
|
|
5131
|
+
/** Emitted when StudioTwo is attached. */
|
|
5132
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
5133
|
+
/** Emitted when StudioTwo is detached. */
|
|
5134
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5135
|
+
/** Emitted when media from user domain is enabled. */
|
|
5136
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5137
|
+
/** Emitted when media from user domain is disabled. */
|
|
5138
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5139
|
+
/** Emitted when Editorless is attached. */
|
|
5140
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
5141
|
+
/** Emitted when Editorless is detached. */
|
|
5142
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
5337
5143
|
/**
|
|
5338
|
-
*
|
|
5339
|
-
* @
|
|
5144
|
+
* A meta site id.
|
|
5145
|
+
* @format GUID
|
|
5340
5146
|
*/
|
|
5341
|
-
|
|
5342
|
-
|
|
5343
|
-
|
|
5147
|
+
metaSiteId?: string;
|
|
5148
|
+
/** A meta site version. Monotonically increasing. */
|
|
5149
|
+
version?: string;
|
|
5150
|
+
/** A timestamp of the event. */
|
|
5151
|
+
timestamp?: string;
|
|
5344
5152
|
/**
|
|
5345
|
-
*
|
|
5346
|
-
*
|
|
5153
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
5154
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
5155
|
+
* @maxSize 4000
|
|
5347
5156
|
*/
|
|
5348
|
-
|
|
5157
|
+
assets?: Asset[];
|
|
5349
5158
|
}
|
|
5350
|
-
|
|
5351
|
-
|
|
5352
|
-
|
|
5353
|
-
|
|
5354
|
-
|
|
5159
|
+
/** @oneof */
|
|
5160
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5161
|
+
/** Emitted on a meta site creation. */
|
|
5162
|
+
siteCreated?: SiteCreated;
|
|
5163
|
+
/** Emitted on a meta site transfer completion. */
|
|
5164
|
+
siteTransferred?: SiteTransferred;
|
|
5165
|
+
/** Emitted on a meta site deletion. */
|
|
5166
|
+
siteDeleted?: SiteDeleted;
|
|
5167
|
+
/** Emitted on a meta site restoration. */
|
|
5168
|
+
siteUndeleted?: SiteUndeleted;
|
|
5169
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5170
|
+
sitePublished?: SitePublished;
|
|
5171
|
+
/** Emitted on a meta site unpublish. */
|
|
5172
|
+
siteUnpublished?: SiteUnpublished;
|
|
5173
|
+
/** Emitted when meta site is marked as template. */
|
|
5174
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5175
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
5176
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5177
|
+
/** Emitted when an application is provisioned (installed). */
|
|
5178
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
5179
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
5180
|
+
serviceRemoved?: ServiceRemoved;
|
|
5181
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
5182
|
+
siteRenamedPayload?: SiteRenamed;
|
|
5183
|
+
/** Emitted when meta site was permanently deleted. */
|
|
5184
|
+
hardDeleted?: SiteHardDeleted;
|
|
5185
|
+
/** Emitted on a namespace change. */
|
|
5186
|
+
namespaceChanged?: NamespaceChanged;
|
|
5187
|
+
/** Emitted when Studio is attached. */
|
|
5188
|
+
studioAssigned?: StudioAssigned;
|
|
5189
|
+
/** Emitted when Studio is detached. */
|
|
5190
|
+
studioUnassigned?: StudioUnassigned;
|
|
5355
5191
|
/**
|
|
5356
|
-
*
|
|
5357
|
-
*
|
|
5358
|
-
*
|
|
5192
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5193
|
+
* the actual URL.
|
|
5194
|
+
*
|
|
5195
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5196
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5359
5197
|
*/
|
|
5360
|
-
|
|
5198
|
+
urlChanged?: SiteUrlChanged;
|
|
5199
|
+
/** Site is marked as PurgedExternally */
|
|
5200
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
5201
|
+
/** Emitted when Odeditor is attached. */
|
|
5202
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
5203
|
+
/** Emitted when Odeditor is detached. */
|
|
5204
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
5205
|
+
/** Emitted when Picasso is attached. */
|
|
5206
|
+
picassoAssigned?: PicassoAssigned;
|
|
5207
|
+
/** Emitted when Picasso is detached. */
|
|
5208
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
5209
|
+
/** Emitted when Wixel is attached. */
|
|
5210
|
+
wixelAssigned?: WixelAssigned;
|
|
5211
|
+
/** Emitted when Wixel is detached. */
|
|
5212
|
+
wixelUnassigned?: WixelUnassigned;
|
|
5213
|
+
/** Emitted when StudioTwo is attached. */
|
|
5214
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
5215
|
+
/** Emitted when StudioTwo is detached. */
|
|
5216
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5217
|
+
/** Emitted when media from user domain is enabled. */
|
|
5218
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5219
|
+
/** Emitted when media from user domain is disabled. */
|
|
5220
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5221
|
+
/** Emitted when Editorless is attached. */
|
|
5222
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
5223
|
+
/** Emitted when Editorless is detached. */
|
|
5224
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
5361
5225
|
}
|
|
5362
|
-
interface
|
|
5363
|
-
/** Restock type. */
|
|
5364
|
-
type?: RestockTypeWithLiterals;
|
|
5226
|
+
interface Asset {
|
|
5365
5227
|
/**
|
|
5366
|
-
*
|
|
5367
|
-
* @
|
|
5368
|
-
* @maxSize 300
|
|
5369
|
-
* @deprecated
|
|
5228
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
5229
|
+
* @maxLength 36
|
|
5370
5230
|
*/
|
|
5371
|
-
|
|
5231
|
+
appDefId?: string;
|
|
5372
5232
|
/**
|
|
5373
|
-
*
|
|
5374
|
-
* @
|
|
5233
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
5234
|
+
* @maxLength 200
|
|
5375
5235
|
*/
|
|
5376
|
-
|
|
5236
|
+
instanceId?: string;
|
|
5237
|
+
/** An application state. */
|
|
5238
|
+
state?: StateWithLiterals;
|
|
5377
5239
|
}
|
|
5378
|
-
declare enum
|
|
5379
|
-
|
|
5380
|
-
|
|
5381
|
-
|
|
5240
|
+
declare enum State {
|
|
5241
|
+
UNKNOWN = "UNKNOWN",
|
|
5242
|
+
ENABLED = "ENABLED",
|
|
5243
|
+
DISABLED = "DISABLED",
|
|
5244
|
+
PENDING = "PENDING",
|
|
5245
|
+
DEMO = "DEMO"
|
|
5382
5246
|
}
|
|
5383
5247
|
/** @enumType */
|
|
5384
|
-
type
|
|
5385
|
-
interface
|
|
5248
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5249
|
+
interface SiteCreated {
|
|
5386
5250
|
/**
|
|
5387
|
-
*
|
|
5251
|
+
* A template identifier (empty if not created from a template).
|
|
5252
|
+
* @maxLength 36
|
|
5253
|
+
*/
|
|
5254
|
+
originTemplateId?: string;
|
|
5255
|
+
/**
|
|
5256
|
+
* An account id of the owner.
|
|
5388
5257
|
* @format GUID
|
|
5389
5258
|
*/
|
|
5390
|
-
|
|
5259
|
+
ownerId?: string;
|
|
5260
|
+
/** A context in which meta site was created. */
|
|
5261
|
+
context?: SiteCreatedContextWithLiterals;
|
|
5391
5262
|
/**
|
|
5392
|
-
*
|
|
5393
|
-
*
|
|
5394
|
-
*
|
|
5263
|
+
* A meta site id from which this site was created.
|
|
5264
|
+
*
|
|
5265
|
+
* In case of a creation from a template it's a template id.
|
|
5266
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5267
|
+
* @format GUID
|
|
5395
5268
|
*/
|
|
5396
|
-
|
|
5269
|
+
originMetaSiteId?: string | null;
|
|
5397
5270
|
/**
|
|
5398
|
-
*
|
|
5399
|
-
* @
|
|
5400
|
-
* @maxSize 5
|
|
5271
|
+
* A meta site name (URL slug).
|
|
5272
|
+
* @maxLength 20
|
|
5401
5273
|
*/
|
|
5402
|
-
|
|
5274
|
+
siteName?: string;
|
|
5275
|
+
/** A namespace. */
|
|
5276
|
+
namespace?: NamespaceWithLiterals;
|
|
5403
5277
|
}
|
|
5404
|
-
|
|
5405
|
-
/**
|
|
5406
|
-
|
|
5407
|
-
/**
|
|
5408
|
-
|
|
5409
|
-
/**
|
|
5410
|
-
|
|
5278
|
+
declare enum SiteCreatedContext {
|
|
5279
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5280
|
+
OTHER = "OTHER",
|
|
5281
|
+
/** A meta site was created from template. */
|
|
5282
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5283
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
5284
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5285
|
+
/** A copy of existing meta site. */
|
|
5286
|
+
DUPLICATE = "DUPLICATE",
|
|
5287
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5288
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5289
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
5290
|
+
FLASH = "FLASH"
|
|
5411
5291
|
}
|
|
5412
|
-
/**
|
|
5413
|
-
|
|
5414
|
-
|
|
5415
|
-
|
|
5416
|
-
*/
|
|
5417
|
-
|
|
5292
|
+
/** @enumType */
|
|
5293
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5294
|
+
declare enum Namespace {
|
|
5295
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5296
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5297
|
+
WIX = "WIX",
|
|
5298
|
+
/** 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. */
|
|
5299
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
5300
|
+
/** 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. */
|
|
5301
|
+
ALBUMS = "ALBUMS",
|
|
5302
|
+
/** 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. */
|
|
5303
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5304
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5305
|
+
HOTELS = "HOTELS",
|
|
5306
|
+
/** 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. */
|
|
5307
|
+
CLUBS = "CLUBS",
|
|
5308
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5309
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5418
5310
|
/**
|
|
5419
|
-
*
|
|
5420
|
-
*
|
|
5311
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5312
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
5421
5313
|
*/
|
|
5422
|
-
|
|
5314
|
+
DEV_SITE = "DEV_SITE",
|
|
5315
|
+
/** 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. */
|
|
5316
|
+
LOGOS = "LOGOS",
|
|
5317
|
+
/** 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. */
|
|
5318
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5319
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5320
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5321
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5322
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5423
5323
|
/**
|
|
5424
|
-
*
|
|
5425
|
-
*
|
|
5324
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5325
|
+
*
|
|
5326
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5426
5327
|
*/
|
|
5427
|
-
|
|
5328
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
5428
5329
|
/**
|
|
5429
|
-
*
|
|
5430
|
-
*
|
|
5330
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
5331
|
+
* Will be accessible from Site List and will not have a website app.
|
|
5332
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
5431
5333
|
*/
|
|
5432
|
-
|
|
5433
|
-
|
|
5434
|
-
|
|
5435
|
-
/**
|
|
5436
|
-
|
|
5437
|
-
/**
|
|
5438
|
-
|
|
5439
|
-
/**
|
|
5440
|
-
|
|
5334
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
5335
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5336
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5337
|
+
/** It is to be used in the Business First efforts. */
|
|
5338
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5339
|
+
/** Bookings business flow with no site. */
|
|
5340
|
+
ANYWHERE = "ANYWHERE",
|
|
5341
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
5342
|
+
HEADLESS = "HEADLESS",
|
|
5441
5343
|
/**
|
|
5442
|
-
*
|
|
5443
|
-
*
|
|
5344
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
5345
|
+
* The site will be used for account level CSM feature for enterprise
|
|
5444
5346
|
*/
|
|
5445
|
-
|
|
5347
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
5348
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
5349
|
+
RISE = "RISE",
|
|
5446
5350
|
/**
|
|
5447
|
-
*
|
|
5448
|
-
*
|
|
5351
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
5352
|
+
* There's a blank site behind the scene but it's blank).
|
|
5353
|
+
* The Mobile company will be the owner of this namespace.
|
|
5449
5354
|
*/
|
|
5450
|
-
|
|
5451
|
-
/**
|
|
5452
|
-
|
|
5453
|
-
/** @internal */
|
|
5454
|
-
declined?: DeclinedStatusDetails;
|
|
5455
|
-
/** @internal */
|
|
5456
|
-
voided?: VoidedStatusDetails;
|
|
5355
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
5356
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5357
|
+
NOWNIA = "NOWNIA",
|
|
5457
5358
|
/**
|
|
5458
|
-
*
|
|
5459
|
-
*
|
|
5460
|
-
* @readonly
|
|
5359
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
5360
|
+
* The Partners company owns this namespace.
|
|
5461
5361
|
*/
|
|
5462
|
-
|
|
5463
|
-
/**
|
|
5464
|
-
|
|
5362
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
5363
|
+
/** Codux Headless Sites */
|
|
5364
|
+
CODUX = "CODUX",
|
|
5365
|
+
/** Bobb - AI Design Creator. */
|
|
5366
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
5465
5367
|
/**
|
|
5466
|
-
*
|
|
5467
|
-
*
|
|
5368
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
5369
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
5468
5370
|
*/
|
|
5469
|
-
|
|
5470
|
-
/**
|
|
5471
|
-
|
|
5371
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
5372
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5373
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5374
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5375
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5376
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5377
|
+
MIMIR = "MIMIR",
|
|
5378
|
+
/** Wix Twins platform. */
|
|
5379
|
+
TWINS = "TWINS",
|
|
5380
|
+
/** Wix Nano. */
|
|
5381
|
+
NANO = "NANO",
|
|
5382
|
+
/** Base44 headless sites. */
|
|
5383
|
+
BASE44 = "BASE44",
|
|
5384
|
+
/** Wix Channels Sites */
|
|
5385
|
+
CHANNELS = "CHANNELS",
|
|
5386
|
+
/** Nautilus platform. */
|
|
5387
|
+
NAUTILUS = "NAUTILUS",
|
|
5472
5388
|
/**
|
|
5473
|
-
*
|
|
5474
|
-
*
|
|
5475
|
-
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5389
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
5390
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
5476
5391
|
*/
|
|
5477
|
-
|
|
5392
|
+
SYMPHONY = "SYMPHONY",
|
|
5393
|
+
/** Nautilus platform app. */
|
|
5394
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
5478
5395
|
/**
|
|
5479
|
-
*
|
|
5480
|
-
*
|
|
5481
|
-
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5482
|
-
* @readonly
|
|
5396
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
5397
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
5483
5398
|
*/
|
|
5484
|
-
|
|
5485
|
-
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5486
|
-
cashRounding?: CashRoundingDetails;
|
|
5399
|
+
VIBU = "VIBU",
|
|
5487
5400
|
/**
|
|
5488
|
-
*
|
|
5489
|
-
*
|
|
5490
|
-
*
|
|
5401
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
5402
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
5403
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
5404
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5491
5405
|
*/
|
|
5492
|
-
|
|
5406
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
5493
5407
|
/**
|
|
5494
|
-
*
|
|
5495
|
-
*
|
|
5408
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
5409
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
5496
5410
|
*/
|
|
5497
|
-
|
|
5411
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
5412
|
+
}
|
|
5413
|
+
/** @enumType */
|
|
5414
|
+
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' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
|
|
5415
|
+
/** Site transferred to another user. */
|
|
5416
|
+
interface SiteTransferred {
|
|
5498
5417
|
/**
|
|
5499
|
-
*
|
|
5500
|
-
* @internal
|
|
5418
|
+
* A previous owner id (user that transfers meta site).
|
|
5501
5419
|
* @format GUID
|
|
5502
|
-
* @immutable
|
|
5503
5420
|
*/
|
|
5504
|
-
|
|
5421
|
+
oldOwnerId?: string;
|
|
5505
5422
|
/**
|
|
5506
|
-
*
|
|
5423
|
+
* A new owner id (user that accepts meta site).
|
|
5507
5424
|
* @format GUID
|
|
5508
5425
|
*/
|
|
5509
|
-
|
|
5426
|
+
newOwnerId?: string;
|
|
5510
5427
|
}
|
|
5511
|
-
/**
|
|
5512
|
-
interface
|
|
5513
|
-
/**
|
|
5514
|
-
|
|
5515
|
-
/** Gift card payment details. */
|
|
5516
|
-
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5517
|
-
/** Membership payment details. */
|
|
5518
|
-
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5428
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
5429
|
+
interface SiteDeleted {
|
|
5430
|
+
/** A deletion context. */
|
|
5431
|
+
deleteContext?: DeleteContext;
|
|
5519
5432
|
}
|
|
5520
|
-
|
|
5521
|
-
|
|
5433
|
+
interface DeleteContext {
|
|
5434
|
+
/** When the meta site was deleted. */
|
|
5435
|
+
dateDeleted?: Date | null;
|
|
5436
|
+
/** A status. */
|
|
5437
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
5522
5438
|
/**
|
|
5523
|
-
*
|
|
5524
|
-
* @
|
|
5439
|
+
* A reason (flow).
|
|
5440
|
+
* @maxLength 255
|
|
5525
5441
|
*/
|
|
5526
|
-
|
|
5442
|
+
deleteOrigin?: string;
|
|
5527
5443
|
/**
|
|
5528
|
-
*
|
|
5529
|
-
* @
|
|
5444
|
+
* A service that deleted it.
|
|
5445
|
+
* @maxLength 255
|
|
5530
5446
|
*/
|
|
5531
|
-
|
|
5447
|
+
initiatorId?: string | null;
|
|
5532
5448
|
}
|
|
5533
|
-
|
|
5534
|
-
|
|
5535
|
-
|
|
5536
|
-
|
|
5537
|
-
|
|
5538
|
-
|
|
5539
|
-
/** @internal */
|
|
5540
|
-
voided?: VoidedStatusDetails;
|
|
5449
|
+
declare enum DeleteStatus {
|
|
5450
|
+
UNKNOWN = "UNKNOWN",
|
|
5451
|
+
TRASH = "TRASH",
|
|
5452
|
+
DELETED = "DELETED",
|
|
5453
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
5454
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
5541
5455
|
}
|
|
5542
|
-
|
|
5543
|
-
|
|
5544
|
-
|
|
5456
|
+
/** @enumType */
|
|
5457
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
5458
|
+
/** Restoration of the meta site. */
|
|
5459
|
+
interface SiteUndeleted {
|
|
5460
|
+
}
|
|
5461
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5462
|
+
interface SitePublished {
|
|
5463
|
+
}
|
|
5464
|
+
interface SiteUnpublished {
|
|
5545
5465
|
/**
|
|
5546
|
-
*
|
|
5547
|
-
* @maxLength
|
|
5466
|
+
* A list of URLs previously associated with the meta site.
|
|
5467
|
+
* @maxLength 4000
|
|
5468
|
+
* @maxSize 10000
|
|
5548
5469
|
*/
|
|
5549
|
-
|
|
5470
|
+
urls?: string[];
|
|
5471
|
+
}
|
|
5472
|
+
interface SiteMarkedAsTemplate {
|
|
5473
|
+
}
|
|
5474
|
+
interface SiteMarkedAsWixSite {
|
|
5475
|
+
}
|
|
5476
|
+
/**
|
|
5477
|
+
* Represents a service provisioned a site.
|
|
5478
|
+
*
|
|
5479
|
+
* Note on `origin_instance_id`:
|
|
5480
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5481
|
+
* This is because of the following scenario:
|
|
5482
|
+
*
|
|
5483
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5484
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5485
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
5486
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5487
|
+
* your site remains consistent with what you initially received and does not include any
|
|
5488
|
+
* changes made to the original template afterward.
|
|
5489
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5490
|
+
*/
|
|
5491
|
+
interface ServiceProvisioned {
|
|
5550
5492
|
/**
|
|
5551
|
-
*
|
|
5552
|
-
*
|
|
5553
|
-
* @maxLength 100
|
|
5493
|
+
* Either UUID or EmbeddedServiceType.
|
|
5494
|
+
* @maxLength 36
|
|
5554
5495
|
*/
|
|
5555
|
-
|
|
5496
|
+
appDefId?: string;
|
|
5556
5497
|
/**
|
|
5557
|
-
*
|
|
5558
|
-
*
|
|
5559
|
-
* Non-exhaustive list of supported values:
|
|
5560
|
-
* + `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`
|
|
5561
|
-
* @maxLength 150
|
|
5562
|
-
* @deprecated Payment method.
|
|
5563
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5564
|
-
* Non-exhaustive list of supported values:
|
|
5565
|
-
* + `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`
|
|
5566
|
-
* @replacedBy payment_method_name
|
|
5567
|
-
* @targetRemovalDate 2026-07-01
|
|
5498
|
+
* Not only UUID. Something here could be something weird.
|
|
5499
|
+
* @maxLength 36
|
|
5568
5500
|
*/
|
|
5569
|
-
|
|
5501
|
+
instanceId?: string;
|
|
5570
5502
|
/**
|
|
5571
|
-
*
|
|
5572
|
-
* @maxLength
|
|
5503
|
+
* An instance id from which this instance is originated.
|
|
5504
|
+
* @maxLength 36
|
|
5573
5505
|
*/
|
|
5574
|
-
|
|
5575
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5576
|
-
offlinePayment?: boolean;
|
|
5506
|
+
originInstanceId?: string;
|
|
5577
5507
|
/**
|
|
5578
|
-
*
|
|
5579
|
-
* @
|
|
5580
|
-
* @replacedBy payment.status
|
|
5581
|
-
* @targetRemovalDate 2026-11-01
|
|
5508
|
+
* A version.
|
|
5509
|
+
* @maxLength 500
|
|
5582
5510
|
*/
|
|
5583
|
-
|
|
5584
|
-
/** Whether there is a payment agreement that allows for future charges. */
|
|
5585
|
-
savedPaymentMethod?: boolean;
|
|
5586
|
-
/** Authorization details. */
|
|
5587
|
-
authorizationDetails?: AuthorizationDetails;
|
|
5511
|
+
version?: string | null;
|
|
5588
5512
|
/**
|
|
5589
|
-
*
|
|
5590
|
-
* @
|
|
5591
|
-
* @maxLength 300
|
|
5513
|
+
* The origin meta site id
|
|
5514
|
+
* @format GUID
|
|
5592
5515
|
*/
|
|
5593
|
-
|
|
5516
|
+
originMetaSiteId?: string | null;
|
|
5517
|
+
}
|
|
5518
|
+
interface ServiceRemoved {
|
|
5594
5519
|
/**
|
|
5595
|
-
*
|
|
5596
|
-
* @
|
|
5520
|
+
* Either UUID or EmbeddedServiceType.
|
|
5521
|
+
* @maxLength 36
|
|
5597
5522
|
*/
|
|
5598
|
-
|
|
5523
|
+
appDefId?: string;
|
|
5599
5524
|
/**
|
|
5600
|
-
*
|
|
5601
|
-
* @internal
|
|
5525
|
+
* Not only UUID. Something here could be something weird.
|
|
5602
5526
|
* @maxLength 36
|
|
5603
5527
|
*/
|
|
5604
|
-
|
|
5605
|
-
/** Platform fee amount associated with this payment. */
|
|
5606
|
-
platformFee?: Price;
|
|
5528
|
+
instanceId?: string;
|
|
5607
5529
|
/**
|
|
5608
|
-
*
|
|
5609
|
-
*
|
|
5610
|
-
* + `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`
|
|
5530
|
+
* A version.
|
|
5531
|
+
* @maxLength 500
|
|
5611
5532
|
*/
|
|
5612
|
-
|
|
5613
|
-
}
|
|
5614
|
-
/** @oneof */
|
|
5615
|
-
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5616
|
-
/** Credit card details. */
|
|
5617
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5618
|
-
}
|
|
5619
|
-
declare enum TransactionStatus {
|
|
5620
|
-
UNDEFINED = "UNDEFINED",
|
|
5621
|
-
APPROVED = "APPROVED",
|
|
5622
|
-
PENDING = "PENDING",
|
|
5623
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5624
|
-
CANCELED = "CANCELED",
|
|
5625
|
-
DECLINED = "DECLINED",
|
|
5626
|
-
REFUNDED = "REFUNDED",
|
|
5627
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5628
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5629
|
-
VOIDED = "VOIDED"
|
|
5533
|
+
version?: string | null;
|
|
5630
5534
|
}
|
|
5631
|
-
/**
|
|
5632
|
-
|
|
5633
|
-
interface CreditCardPaymentMethodDetails {
|
|
5535
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
5536
|
+
interface SiteRenamed {
|
|
5634
5537
|
/**
|
|
5635
|
-
*
|
|
5636
|
-
* @maxLength
|
|
5538
|
+
* A new meta site name (URL slug).
|
|
5539
|
+
* @maxLength 20
|
|
5637
5540
|
*/
|
|
5638
|
-
|
|
5541
|
+
newSiteName?: string;
|
|
5639
5542
|
/**
|
|
5640
|
-
*
|
|
5641
|
-
* @maxLength
|
|
5543
|
+
* A previous meta site name (URL slug).
|
|
5544
|
+
* @maxLength 255
|
|
5642
5545
|
*/
|
|
5643
|
-
|
|
5546
|
+
oldSiteName?: string;
|
|
5644
5547
|
}
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
5651
|
-
/**
|
|
5652
|
-
|
|
5653
|
-
/**
|
|
5654
|
-
* List of captures associated with payment
|
|
5655
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5656
|
-
* @maxSize 1
|
|
5657
|
-
*/
|
|
5658
|
-
captures?: AuthorizationCapture[];
|
|
5659
|
-
/** Void associated with payment */
|
|
5660
|
-
void?: AuthorizationVoid;
|
|
5661
|
-
/** Scheduled action for this transaction */
|
|
5662
|
-
scheduledAction?: V1ScheduledAction;
|
|
5548
|
+
/**
|
|
5549
|
+
* Hard deletion of the meta site.
|
|
5550
|
+
*
|
|
5551
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
5552
|
+
*/
|
|
5553
|
+
interface SiteHardDeleted {
|
|
5554
|
+
/** A deletion context. */
|
|
5555
|
+
deleteContext?: DeleteContext;
|
|
5663
5556
|
}
|
|
5664
|
-
interface
|
|
5665
|
-
/**
|
|
5666
|
-
|
|
5667
|
-
|
|
5668
|
-
|
|
5669
|
-
|
|
5670
|
-
|
|
5671
|
-
|
|
5672
|
-
|
|
5557
|
+
interface NamespaceChanged {
|
|
5558
|
+
/** A previous namespace. */
|
|
5559
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
5560
|
+
/** A new namespace. */
|
|
5561
|
+
newNamespace?: NamespaceWithLiterals;
|
|
5562
|
+
}
|
|
5563
|
+
/** Assigned Studio editor */
|
|
5564
|
+
interface StudioAssigned {
|
|
5565
|
+
}
|
|
5566
|
+
/** Unassigned Studio editor */
|
|
5567
|
+
interface StudioUnassigned {
|
|
5568
|
+
}
|
|
5569
|
+
/**
|
|
5570
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
5571
|
+
*
|
|
5572
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5573
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5574
|
+
*
|
|
5575
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
5576
|
+
*/
|
|
5577
|
+
interface SiteUrlChanged {
|
|
5578
|
+
}
|
|
5579
|
+
/**
|
|
5580
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5581
|
+
* Consumed by other teams to remove relevant data.
|
|
5582
|
+
*/
|
|
5583
|
+
interface SitePurgedExternally {
|
|
5673
5584
|
/**
|
|
5674
|
-
*
|
|
5675
|
-
* @
|
|
5585
|
+
* @maxLength 2048
|
|
5586
|
+
* @maxSize 100
|
|
5587
|
+
* @deprecated
|
|
5588
|
+
* @targetRemovalDate 2025-04-15
|
|
5676
5589
|
*/
|
|
5677
|
-
|
|
5678
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5679
|
-
createdDate?: Date | null;
|
|
5680
|
-
/** In case of status is FAILED may contain failure details */
|
|
5681
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5590
|
+
appDefId?: string[];
|
|
5682
5591
|
}
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
PENDING = "PENDING",
|
|
5686
|
-
/** Capture operation succeeded. */
|
|
5687
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5688
|
-
/** Capture operation failed. */
|
|
5689
|
-
FAILED = "FAILED"
|
|
5592
|
+
/** Assigned Odeditor */
|
|
5593
|
+
interface OdeditorAssigned {
|
|
5690
5594
|
}
|
|
5691
|
-
/**
|
|
5692
|
-
|
|
5693
|
-
interface AuthorizationActionFailureDetails {
|
|
5694
|
-
/** @maxLength 100 */
|
|
5695
|
-
failureCode?: string;
|
|
5595
|
+
/** Unassigned Odeditor */
|
|
5596
|
+
interface OdeditorUnassigned {
|
|
5696
5597
|
}
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
5700
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5701
|
-
voidedDate?: Date | null;
|
|
5702
|
-
/** In case of status is FAILED may contain failure details */
|
|
5703
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
5704
|
-
/** Reason of void action */
|
|
5705
|
-
reason?: ReasonWithLiterals;
|
|
5598
|
+
/** Assigned Picasso editor */
|
|
5599
|
+
interface PicassoAssigned {
|
|
5706
5600
|
}
|
|
5707
|
-
|
|
5708
|
-
|
|
5709
|
-
PENDING = "PENDING",
|
|
5710
|
-
/** Void operation succeeded. */
|
|
5711
|
-
SUCCEEDED = "SUCCEEDED",
|
|
5712
|
-
/** Void operation failed. */
|
|
5713
|
-
FAILED = "FAILED"
|
|
5601
|
+
/** Unassigned Picasso */
|
|
5602
|
+
interface PicassoUnassigned {
|
|
5714
5603
|
}
|
|
5715
|
-
/**
|
|
5716
|
-
|
|
5717
|
-
/** Reason the authorization was voided. */
|
|
5718
|
-
declare enum Reason {
|
|
5719
|
-
/** Authorization was voided by user. */
|
|
5720
|
-
MANUAL = "MANUAL",
|
|
5721
|
-
/** Authorization passed execution date. */
|
|
5722
|
-
SCHEDULED = "SCHEDULED"
|
|
5604
|
+
/** Assigned Wixel */
|
|
5605
|
+
interface WixelAssigned {
|
|
5723
5606
|
}
|
|
5724
|
-
/**
|
|
5725
|
-
|
|
5726
|
-
interface V1ScheduledAction {
|
|
5727
|
-
/** Type of the action. */
|
|
5728
|
-
actionType?: ActionTypeWithLiterals;
|
|
5729
|
-
/** The date and time of the action. */
|
|
5730
|
-
executionDate?: Date | null;
|
|
5607
|
+
/** Unassigned Wixel */
|
|
5608
|
+
interface WixelUnassigned {
|
|
5731
5609
|
}
|
|
5732
|
-
|
|
5733
|
-
|
|
5734
|
-
|
|
5610
|
+
/** Assigned StudioTwo */
|
|
5611
|
+
interface StudioTwoAssigned {
|
|
5612
|
+
}
|
|
5613
|
+
/** Unassigned StudioTwo */
|
|
5614
|
+
interface StudioTwoUnassigned {
|
|
5615
|
+
}
|
|
5616
|
+
/** Media from user domain is enabled. */
|
|
5617
|
+
interface UserDomainMediaEnabled {
|
|
5618
|
+
}
|
|
5619
|
+
/** Media from user domain is disabled. */
|
|
5620
|
+
interface UserDomainMediaDisabled {
|
|
5621
|
+
}
|
|
5622
|
+
/** Assigned Editorless */
|
|
5623
|
+
interface EditorlessAssigned {
|
|
5624
|
+
}
|
|
5625
|
+
/** Unassigned Editorless */
|
|
5626
|
+
interface EditorlessUnassigned {
|
|
5627
|
+
}
|
|
5628
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
5629
|
+
}
|
|
5630
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
5631
|
+
hasCustomConfigurations?: boolean;
|
|
5632
|
+
}
|
|
5633
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
5634
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
5635
|
+
sendCustomEmailConfigs?: boolean;
|
|
5636
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5637
|
+
origin?: OriginWithLiterals;
|
|
5638
|
+
}
|
|
5639
|
+
declare enum Origin {
|
|
5640
|
+
OPT_IN = "OPT_IN",
|
|
5641
|
+
MIGRATION = "MIGRATION"
|
|
5735
5642
|
}
|
|
5736
5643
|
/** @enumType */
|
|
5737
|
-
type
|
|
5738
|
-
interface
|
|
5739
|
-
|
|
5740
|
-
|
|
5741
|
-
|
|
5742
|
-
|
|
5743
|
-
|
|
5744
|
-
|
|
5745
|
-
|
|
5746
|
-
|
|
5747
|
-
* 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.
|
|
5748
|
-
* @readonly
|
|
5749
|
-
* @immutable
|
|
5750
|
-
*/
|
|
5751
|
-
createdDate?: Date | null;
|
|
5644
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
5645
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
5646
|
+
success?: boolean;
|
|
5647
|
+
}
|
|
5648
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
5649
|
+
}
|
|
5650
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
5651
|
+
inPopulation?: boolean;
|
|
5652
|
+
}
|
|
5653
|
+
interface PreparePaymentCollectionRequest {
|
|
5752
5654
|
/**
|
|
5753
|
-
*
|
|
5754
|
-
* @
|
|
5655
|
+
* Ecom order ID.
|
|
5656
|
+
* @minLength 1
|
|
5657
|
+
* @maxLength 100
|
|
5755
5658
|
*/
|
|
5756
|
-
|
|
5659
|
+
ecomOrderId: string;
|
|
5660
|
+
/** Amount to collect */
|
|
5661
|
+
amount: Price;
|
|
5757
5662
|
/**
|
|
5758
|
-
*
|
|
5759
|
-
*
|
|
5760
|
-
*
|
|
5663
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
5664
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
5665
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
5761
5666
|
*/
|
|
5762
|
-
|
|
5667
|
+
paymentGatewayOrderId?: string | null;
|
|
5763
5668
|
/**
|
|
5764
|
-
*
|
|
5765
|
-
*
|
|
5669
|
+
* Whether to delay capture of the payment.
|
|
5670
|
+
* Default: false
|
|
5671
|
+
* @deprecated Whether to delay capture of the payment.
|
|
5672
|
+
* Default: false
|
|
5673
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
5674
|
+
* @targetRemovalDate 2024-09-30
|
|
5766
5675
|
*/
|
|
5767
|
-
|
|
5676
|
+
delayedCapture?: boolean;
|
|
5768
5677
|
/**
|
|
5769
|
-
*
|
|
5770
|
-
*
|
|
5771
|
-
*
|
|
5678
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
5679
|
+
* Default: `true`
|
|
5680
|
+
* @internal
|
|
5772
5681
|
*/
|
|
5773
|
-
|
|
5682
|
+
merchantInitiated?: boolean | null;
|
|
5774
5683
|
/**
|
|
5775
|
-
*
|
|
5776
|
-
* @
|
|
5777
|
-
* @readonly
|
|
5778
|
-
* @immutable
|
|
5684
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
5685
|
+
* @internal
|
|
5779
5686
|
*/
|
|
5780
|
-
|
|
5781
|
-
|
|
5782
|
-
|
|
5783
|
-
/** Chargeback was approved. */
|
|
5784
|
-
APPROVED = "APPROVED",
|
|
5785
|
-
/** Chargeback was reversed. */
|
|
5786
|
-
REVERSED = "REVERSED"
|
|
5687
|
+
redirectUrls?: RedirectUrls;
|
|
5688
|
+
/** Delayed capture payment settings */
|
|
5689
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
5787
5690
|
}
|
|
5788
|
-
|
|
5789
|
-
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5790
|
-
interface PaymentMethodName {
|
|
5691
|
+
interface RedirectUrls {
|
|
5791
5692
|
/**
|
|
5792
|
-
*
|
|
5793
|
-
* @
|
|
5693
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
5694
|
+
* @format WEB_URL
|
|
5794
5695
|
*/
|
|
5795
|
-
|
|
5696
|
+
successUrl?: string | null;
|
|
5796
5697
|
/**
|
|
5797
|
-
*
|
|
5798
|
-
*
|
|
5799
|
-
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
5800
|
-
* @maxLength 150
|
|
5698
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
5699
|
+
* @format WEB_URL
|
|
5801
5700
|
*/
|
|
5802
|
-
|
|
5701
|
+
cancelUrl?: string | null;
|
|
5803
5702
|
/**
|
|
5804
|
-
*
|
|
5805
|
-
*
|
|
5806
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
5703
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
5704
|
+
* @format WEB_URL
|
|
5807
5705
|
*/
|
|
5808
|
-
|
|
5809
|
-
}
|
|
5810
|
-
interface GiftCardPaymentDetails {
|
|
5706
|
+
errorUrl?: string | null;
|
|
5811
5707
|
/**
|
|
5812
|
-
*
|
|
5813
|
-
* @
|
|
5708
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
5709
|
+
* @format WEB_URL
|
|
5814
5710
|
*/
|
|
5815
|
-
|
|
5711
|
+
pendingUrl?: string | null;
|
|
5712
|
+
}
|
|
5713
|
+
interface DelayedCaptureSettings {
|
|
5714
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
5715
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
5716
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
5717
|
+
delayDuration?: Duration;
|
|
5718
|
+
}
|
|
5719
|
+
declare enum ScheduledAction {
|
|
5720
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
5721
|
+
VOID = "VOID",
|
|
5722
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
5723
|
+
CAPTURE = "CAPTURE"
|
|
5724
|
+
}
|
|
5725
|
+
/** @enumType */
|
|
5726
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
5727
|
+
interface Duration {
|
|
5816
5728
|
/**
|
|
5817
|
-
*
|
|
5818
|
-
* @
|
|
5819
|
-
* @deprecated
|
|
5729
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
5730
|
+
* @min 1
|
|
5820
5731
|
*/
|
|
5821
|
-
|
|
5732
|
+
count?: number;
|
|
5733
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
5734
|
+
unit?: DurationUnitWithLiterals;
|
|
5735
|
+
}
|
|
5736
|
+
declare enum DurationUnit {
|
|
5737
|
+
MINUTES = "MINUTES",
|
|
5738
|
+
HOURS = "HOURS",
|
|
5739
|
+
DAYS = "DAYS"
|
|
5740
|
+
}
|
|
5741
|
+
/** @enumType */
|
|
5742
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
5743
|
+
interface PreparePaymentCollectionResponse {
|
|
5744
|
+
/** Payment gateway order id which is associated with given payment */
|
|
5745
|
+
paymentGatewayOrderId?: string;
|
|
5746
|
+
}
|
|
5747
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
5822
5748
|
/**
|
|
5823
|
-
*
|
|
5824
|
-
* @
|
|
5749
|
+
* Ecom order ID.
|
|
5750
|
+
* @minLength 1
|
|
5751
|
+
* @maxLength 100
|
|
5825
5752
|
*/
|
|
5826
|
-
|
|
5753
|
+
ecomOrderId: string;
|
|
5754
|
+
}
|
|
5755
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
5756
|
+
/** Payment collectability status */
|
|
5757
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
5758
|
+
/** Collectable order amount */
|
|
5759
|
+
amount?: Price;
|
|
5827
5760
|
/**
|
|
5828
|
-
* Whether
|
|
5829
|
-
* @
|
|
5830
|
-
* @deprecated Whether the gift card is voided.
|
|
5831
|
-
* @replacedBy payment.status
|
|
5832
|
-
* @targetRemovalDate 2026-11-01
|
|
5761
|
+
* Whether authorization supported
|
|
5762
|
+
* @internal
|
|
5833
5763
|
*/
|
|
5834
|
-
|
|
5764
|
+
authorizationSupported?: boolean;
|
|
5835
5765
|
/**
|
|
5836
|
-
*
|
|
5837
|
-
* @
|
|
5838
|
-
* @immutable
|
|
5766
|
+
* Whether custom amount is supported for payment collection
|
|
5767
|
+
* @internal
|
|
5839
5768
|
*/
|
|
5840
|
-
|
|
5769
|
+
customAmountSupported?: boolean;
|
|
5841
5770
|
}
|
|
5842
|
-
|
|
5843
|
-
|
|
5844
|
-
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5771
|
+
declare enum PaymentCollectabilityStatus {
|
|
5772
|
+
UNKNOWN = "UNKNOWN",
|
|
5773
|
+
COLLECTABLE = "COLLECTABLE",
|
|
5774
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
5775
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
5776
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
5777
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
5778
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
5779
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
5780
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
5781
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
5782
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
5783
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
5784
|
+
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
5785
|
+
}
|
|
5786
|
+
/** @enumType */
|
|
5787
|
+
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' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
|
|
5788
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
5848
5789
|
/**
|
|
5849
|
-
* ID
|
|
5790
|
+
* Order ID.
|
|
5850
5791
|
* @minLength 1
|
|
5851
5792
|
* @maxLength 100
|
|
5852
5793
|
*/
|
|
5853
|
-
|
|
5794
|
+
orderId: string;
|
|
5795
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
5796
|
+
amount: Price;
|
|
5854
5797
|
/**
|
|
5855
|
-
* Payment
|
|
5856
|
-
*
|
|
5857
|
-
*
|
|
5858
|
-
* @
|
|
5798
|
+
* Payment method name provided by user.
|
|
5799
|
+
*
|
|
5800
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5801
|
+
* @internal
|
|
5859
5802
|
*/
|
|
5860
|
-
|
|
5861
|
-
|
|
5862
|
-
|
|
5803
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
5804
|
+
}
|
|
5805
|
+
/**
|
|
5806
|
+
* User-defined payment method name.
|
|
5807
|
+
* Allows specifying either a predefined type or a custom name.
|
|
5808
|
+
*/
|
|
5809
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
5810
|
+
/** Predefined payment method. */
|
|
5811
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5863
5812
|
/**
|
|
5864
|
-
*
|
|
5813
|
+
* Custom payment method name provided by user.
|
|
5814
|
+
*
|
|
5815
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5865
5816
|
* @minLength 1
|
|
5866
|
-
* @maxLength
|
|
5867
|
-
*/
|
|
5868
|
-
externalTransactionId?: string | null;
|
|
5869
|
-
/**
|
|
5870
|
-
* Whether the membership is voided.
|
|
5871
|
-
* @readonly
|
|
5872
|
-
* @deprecated Whether the membership is voided.
|
|
5873
|
-
* @replacedBy payment.status
|
|
5874
|
-
* @targetRemovalDate 2026-11-01
|
|
5817
|
+
* @maxLength 150
|
|
5875
5818
|
*/
|
|
5876
|
-
|
|
5819
|
+
custom?: string | null;
|
|
5820
|
+
}
|
|
5821
|
+
/** @oneof */
|
|
5822
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
5823
|
+
/** Predefined payment method. */
|
|
5824
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5877
5825
|
/**
|
|
5878
|
-
*
|
|
5879
|
-
*
|
|
5826
|
+
* Custom payment method name provided by user.
|
|
5827
|
+
*
|
|
5828
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5829
|
+
* @minLength 1
|
|
5830
|
+
* @maxLength 150
|
|
5880
5831
|
*/
|
|
5881
|
-
|
|
5882
|
-
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5883
|
-
futureMembership?: FutureMembershipDetails;
|
|
5832
|
+
custom?: string | null;
|
|
5884
5833
|
}
|
|
5885
|
-
|
|
5886
|
-
|
|
5887
|
-
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
5892
|
-
|
|
5893
|
-
VOIDED = "VOIDED"
|
|
5834
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
5835
|
+
declare enum PredefinedPaymentMethod {
|
|
5836
|
+
/** Cash payment. */
|
|
5837
|
+
CASH = "CASH",
|
|
5838
|
+
/** Bank transfer. */
|
|
5839
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
5840
|
+
/** Payment by check. */
|
|
5841
|
+
CHECK = "CHECK"
|
|
5894
5842
|
}
|
|
5895
5843
|
/** @enumType */
|
|
5896
|
-
type
|
|
5897
|
-
interface
|
|
5844
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
5845
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
5846
|
+
}
|
|
5847
|
+
interface MarkOrderAsPaidRequest {
|
|
5898
5848
|
/**
|
|
5899
|
-
*
|
|
5900
|
-
* @
|
|
5849
|
+
* Ecom order ID.
|
|
5850
|
+
* @minLength 1
|
|
5851
|
+
* @maxLength 100
|
|
5901
5852
|
*/
|
|
5902
|
-
|
|
5853
|
+
ecomOrderId: string;
|
|
5903
5854
|
/**
|
|
5904
|
-
*
|
|
5905
|
-
*
|
|
5855
|
+
* Payment method name provided by user.
|
|
5856
|
+
*
|
|
5857
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5858
|
+
* @internal
|
|
5906
5859
|
*/
|
|
5907
|
-
|
|
5860
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
5908
5861
|
}
|
|
5909
|
-
interface
|
|
5910
|
-
/**
|
|
5911
|
-
|
|
5912
|
-
|
|
5913
|
-
|
|
5914
|
-
receiptId?: string;
|
|
5862
|
+
interface MarkOrderAsPaidResponse {
|
|
5863
|
+
/** Updated order. */
|
|
5864
|
+
order?: Order;
|
|
5865
|
+
}
|
|
5866
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
5915
5867
|
/**
|
|
5916
|
-
*
|
|
5868
|
+
* IDs of orders to mark as paid.
|
|
5869
|
+
* @minSize 1
|
|
5870
|
+
* @maxSize 100
|
|
5917
5871
|
* @minLength 1
|
|
5918
|
-
* @maxLength
|
|
5872
|
+
* @maxLength 100
|
|
5919
5873
|
*/
|
|
5920
|
-
|
|
5874
|
+
ecomOrderIds: string[];
|
|
5921
5875
|
}
|
|
5922
|
-
interface
|
|
5876
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
5923
5877
|
/**
|
|
5924
|
-
*
|
|
5925
|
-
*
|
|
5878
|
+
* Items updated by the bulk action.
|
|
5879
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
5926
5880
|
*/
|
|
5927
|
-
|
|
5881
|
+
results?: BulkOrderResult[];
|
|
5882
|
+
/** Bulk action metadata. */
|
|
5883
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
5884
|
+
}
|
|
5885
|
+
interface BulkOrderResult {
|
|
5886
|
+
/** Item metadata. */
|
|
5887
|
+
itemMetadata?: ItemMetadata;
|
|
5928
5888
|
/**
|
|
5929
|
-
*
|
|
5930
|
-
*
|
|
5889
|
+
* Updated order.
|
|
5890
|
+
*
|
|
5891
|
+
* Returned when `returnFullEntity = true`.
|
|
5931
5892
|
*/
|
|
5932
|
-
|
|
5893
|
+
item?: Order;
|
|
5894
|
+
}
|
|
5895
|
+
interface ItemMetadata {
|
|
5896
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5897
|
+
id?: string | null;
|
|
5898
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5899
|
+
originalIndex?: number;
|
|
5900
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5901
|
+
success?: boolean;
|
|
5902
|
+
/** Details about the error in case of failure. */
|
|
5903
|
+
error?: ApplicationError;
|
|
5904
|
+
}
|
|
5905
|
+
interface ApplicationError {
|
|
5906
|
+
/** Error code. */
|
|
5907
|
+
code?: string;
|
|
5908
|
+
/** Description of the error. */
|
|
5909
|
+
description?: string;
|
|
5910
|
+
/** Data related to the error. */
|
|
5911
|
+
data?: Record<string, any> | null;
|
|
5912
|
+
}
|
|
5913
|
+
interface BulkActionMetadata {
|
|
5914
|
+
/** Number of items that were successfully processed. */
|
|
5915
|
+
totalSuccesses?: number;
|
|
5916
|
+
/** Number of items that couldn't be processed. */
|
|
5917
|
+
totalFailures?: number;
|
|
5918
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5919
|
+
undetailedFailures?: number;
|
|
5920
|
+
}
|
|
5921
|
+
interface GetRefundabilityStatusRequest {
|
|
5933
5922
|
/**
|
|
5934
|
-
*
|
|
5923
|
+
* Order ID.
|
|
5935
5924
|
* @minLength 1
|
|
5936
|
-
* @maxLength
|
|
5925
|
+
* @maxLength 100
|
|
5937
5926
|
*/
|
|
5938
|
-
|
|
5927
|
+
ecomOrderId: string;
|
|
5939
5928
|
}
|
|
5940
|
-
interface
|
|
5941
|
-
/**
|
|
5942
|
-
* Payment amount before cash rounding was applied.
|
|
5943
|
-
* When provided, balance and status calculations use this value instead of `amount`
|
|
5944
|
-
* to prevent false overpayment or underpayment due to rounding.
|
|
5945
|
-
*/
|
|
5946
|
-
unroundedAmount?: Price;
|
|
5929
|
+
interface GetRefundabilityStatusResponse {
|
|
5947
5930
|
/**
|
|
5948
|
-
*
|
|
5949
|
-
*
|
|
5950
|
-
* @readonly
|
|
5931
|
+
* Refundability details.
|
|
5932
|
+
* @maxSize 300
|
|
5951
5933
|
*/
|
|
5952
|
-
|
|
5953
|
-
}
|
|
5954
|
-
declare enum PaymentStatus {
|
|
5955
|
-
/** Payment was charged successfully. */
|
|
5956
|
-
APPROVED = "APPROVED",
|
|
5957
|
-
/** Payment is being processed and hasn't been confirmed yet. */
|
|
5958
|
-
PENDING = "PENDING",
|
|
5959
|
-
/** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
|
|
5960
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5961
|
-
/** Payment was canceled before it was charged. */
|
|
5962
|
-
CANCELED = "CANCELED",
|
|
5963
|
-
/** Payment was declined by the payment provider. */
|
|
5964
|
-
DECLINED = "DECLINED",
|
|
5965
|
-
/** Payment was fully refunded. */
|
|
5966
|
-
REFUNDED = "REFUNDED",
|
|
5967
|
-
/** Part of the payment amount was refunded. */
|
|
5968
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5969
|
-
/** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
|
|
5970
|
-
AUTHORIZED = "AUTHORIZED",
|
|
5934
|
+
refundabilities?: Refundability[];
|
|
5971
5935
|
/**
|
|
5972
|
-
*
|
|
5973
|
-
*
|
|
5974
|
-
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
5936
|
+
* Whether the order supports refunding per item.
|
|
5937
|
+
* @deprecated
|
|
5975
5938
|
*/
|
|
5976
|
-
|
|
5977
|
-
}
|
|
5978
|
-
/** @enumType */
|
|
5979
|
-
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5980
|
-
interface CanceledStatusDetails {
|
|
5981
|
-
reason?: CanceledReasonWithLiterals;
|
|
5939
|
+
refundablePerItem?: boolean;
|
|
5982
5940
|
}
|
|
5983
|
-
|
|
5984
|
-
/**
|
|
5985
|
-
|
|
5986
|
-
/**
|
|
5987
|
-
|
|
5941
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5942
|
+
/** Reason why payment is not refundable. */
|
|
5943
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5944
|
+
/** Reason why payment is only refundable manually. */
|
|
5945
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5946
|
+
/** Payment ID. */
|
|
5947
|
+
paymentId?: string;
|
|
5948
|
+
/** Payment refundability status. */
|
|
5949
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
5950
|
+
/** Link to payment provider dashboard. */
|
|
5951
|
+
providerLink?: string | null;
|
|
5988
5952
|
}
|
|
5989
|
-
/** @
|
|
5990
|
-
|
|
5991
|
-
|
|
5992
|
-
|
|
5953
|
+
/** @oneof */
|
|
5954
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5955
|
+
/** Reason why payment is not refundable. */
|
|
5956
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5957
|
+
/** Reason why payment is only refundable manually. */
|
|
5958
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5993
5959
|
}
|
|
5994
|
-
declare enum
|
|
5995
|
-
|
|
5996
|
-
|
|
5997
|
-
|
|
5998
|
-
EXPIRED = "EXPIRED",
|
|
5999
|
-
/** Insufficient funds. */
|
|
6000
|
-
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6001
|
-
/** Gift card was disabled before charge was attempted. */
|
|
6002
|
-
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
5960
|
+
declare enum RefundableStatus {
|
|
5961
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
5962
|
+
MANUAL = "MANUAL",
|
|
5963
|
+
REFUNDABLE = "REFUNDABLE"
|
|
6003
5964
|
}
|
|
6004
5965
|
/** @enumType */
|
|
6005
|
-
type
|
|
6006
|
-
|
|
6007
|
-
|
|
5966
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
5967
|
+
declare enum NonRefundableReason {
|
|
5968
|
+
NONE = "NONE",
|
|
5969
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
5970
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
5971
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
5972
|
+
NOT_PAID = "NOT_PAID",
|
|
5973
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5974
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
5975
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5976
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
5977
|
+
FORBIDDEN = "FORBIDDEN",
|
|
5978
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5979
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5980
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
6008
5981
|
}
|
|
6009
|
-
|
|
6010
|
-
|
|
6011
|
-
|
|
6012
|
-
|
|
6013
|
-
|
|
5982
|
+
/** @enumType */
|
|
5983
|
+
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';
|
|
5984
|
+
declare enum ManuallyRefundableReason {
|
|
5985
|
+
EXPIRED = "EXPIRED",
|
|
5986
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
5987
|
+
OFFLINE = "OFFLINE",
|
|
5988
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
6014
5989
|
}
|
|
6015
5990
|
/** @enumType */
|
|
6016
|
-
type
|
|
6017
|
-
interface
|
|
6018
|
-
/** @internal */
|
|
6019
|
-
canceled?: CanceledStatusDetails;
|
|
6020
|
-
/** @internal */
|
|
6021
|
-
declined?: DeclinedStatusDetails;
|
|
6022
|
-
/** @internal */
|
|
6023
|
-
voided?: VoidedStatusDetails;
|
|
5991
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
5992
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
6024
5993
|
/**
|
|
6025
|
-
*
|
|
6026
|
-
* @internal
|
|
5994
|
+
* Ecom order ID.
|
|
6027
5995
|
* @minLength 1
|
|
6028
|
-
* @maxLength
|
|
5996
|
+
* @maxLength 100
|
|
6029
5997
|
*/
|
|
6030
|
-
|
|
6031
|
-
|
|
6032
|
-
|
|
6033
|
-
|
|
6034
|
-
|
|
6035
|
-
|
|
6036
|
-
|
|
6037
|
-
|
|
6038
|
-
|
|
6039
|
-
|
|
5998
|
+
ecomOrderId: string;
|
|
5999
|
+
/** Information about the user who initiated the payment. */
|
|
6000
|
+
chargedBy?: ChargedBy;
|
|
6001
|
+
/**
|
|
6002
|
+
* Whether to delay capture of the payment.
|
|
6003
|
+
*
|
|
6004
|
+
* Default: false
|
|
6005
|
+
* @internal
|
|
6006
|
+
*/
|
|
6007
|
+
delayedCapture?: boolean;
|
|
6040
6008
|
}
|
|
6041
|
-
interface
|
|
6009
|
+
interface ChargedBy {
|
|
6042
6010
|
/**
|
|
6043
|
-
*
|
|
6011
|
+
* ID - id of the user who initiated the payment
|
|
6044
6012
|
* @format GUID
|
|
6045
|
-
* @readonly
|
|
6046
6013
|
*/
|
|
6047
6014
|
id?: string;
|
|
6048
6015
|
/**
|
|
6049
|
-
*
|
|
6050
|
-
* @
|
|
6016
|
+
* Full name - name of the user who initiated the payment
|
|
6017
|
+
* @minLength 1
|
|
6018
|
+
* @maxLength 200
|
|
6051
6019
|
*/
|
|
6052
|
-
|
|
6053
|
-
|
|
6054
|
-
|
|
6020
|
+
fullName?: string | null;
|
|
6021
|
+
}
|
|
6022
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
6023
|
+
/** ID of the order created in the payment gateway */
|
|
6024
|
+
paymentGatewayOrderId?: string;
|
|
6025
|
+
}
|
|
6026
|
+
interface ChargeMembershipsRequest {
|
|
6055
6027
|
/**
|
|
6056
|
-
*
|
|
6057
|
-
* @
|
|
6058
|
-
* @
|
|
6028
|
+
* Order ID.
|
|
6029
|
+
* @minLength 1
|
|
6030
|
+
* @maxLength 100
|
|
6059
6031
|
*/
|
|
6060
|
-
|
|
6032
|
+
ecomOrderId: string;
|
|
6061
6033
|
/**
|
|
6062
|
-
*
|
|
6063
|
-
*
|
|
6034
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
6035
|
+
* but a user which is using the membership on behalf of the a member
|
|
6036
|
+
* @format GUID
|
|
6064
6037
|
*/
|
|
6065
|
-
|
|
6038
|
+
memberId: string;
|
|
6066
6039
|
/**
|
|
6067
|
-
*
|
|
6068
|
-
* @
|
|
6069
|
-
* @
|
|
6070
|
-
* @immutable
|
|
6040
|
+
* List of items to be paid by memberships
|
|
6041
|
+
* @minSize 1
|
|
6042
|
+
* @maxSize 300
|
|
6071
6043
|
*/
|
|
6072
|
-
|
|
6044
|
+
membershipCharges?: MembershipChargeItem[];
|
|
6073
6045
|
}
|
|
6074
|
-
interface
|
|
6046
|
+
interface MembershipChargeItem {
|
|
6075
6047
|
/**
|
|
6076
|
-
*
|
|
6048
|
+
* The id of used membership
|
|
6049
|
+
* @minLength 1
|
|
6050
|
+
* @maxLength 100
|
|
6051
|
+
*/
|
|
6052
|
+
membershipId?: string;
|
|
6053
|
+
/**
|
|
6054
|
+
* ID of the application providing this payment option
|
|
6077
6055
|
* @format GUID
|
|
6078
|
-
* @immutable
|
|
6079
6056
|
*/
|
|
6080
|
-
|
|
6057
|
+
appId?: string;
|
|
6058
|
+
/** The name of used membership */
|
|
6059
|
+
membershipName?: MembershipName;
|
|
6060
|
+
/** Additional data about this membership */
|
|
6061
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
6062
|
+
/** Catalog and item reference info. */
|
|
6063
|
+
catalogReference?: CatalogReference;
|
|
6064
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
6065
|
+
serviceProperties?: ServiceProperties;
|
|
6081
6066
|
/**
|
|
6082
|
-
*
|
|
6083
|
-
*
|
|
6067
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
6068
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
6069
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
6070
|
+
* @minLength 1
|
|
6071
|
+
* @maxLength 36
|
|
6084
6072
|
*/
|
|
6085
|
-
|
|
6086
|
-
/** Refund status. */
|
|
6087
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
6088
|
-
/** Optional details of current refund status. */
|
|
6089
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
6073
|
+
rootCatalogItemId?: string | null;
|
|
6090
6074
|
/**
|
|
6091
|
-
*
|
|
6092
|
-
*
|
|
6093
|
-
* @
|
|
6075
|
+
* line item id of Checkout/Order line item
|
|
6076
|
+
* @minLength 1
|
|
6077
|
+
* @maxLength 100
|
|
6094
6078
|
*/
|
|
6095
|
-
|
|
6096
|
-
|
|
6097
|
-
|
|
6079
|
+
lineItemId?: string;
|
|
6080
|
+
}
|
|
6081
|
+
interface MembershipName {
|
|
6098
6082
|
/**
|
|
6099
|
-
*
|
|
6100
|
-
* @
|
|
6083
|
+
* Membership name in the site's original language.
|
|
6084
|
+
* @maxLength 100
|
|
6101
6085
|
*/
|
|
6102
|
-
|
|
6086
|
+
original?: string;
|
|
6103
6087
|
/**
|
|
6104
|
-
*
|
|
6105
|
-
*
|
|
6106
|
-
*
|
|
6107
|
-
* @
|
|
6088
|
+
* Membership name translated into the buyer's language.
|
|
6089
|
+
*
|
|
6090
|
+
* Default: The value of `original`
|
|
6091
|
+
* @maxLength 100
|
|
6108
6092
|
*/
|
|
6109
|
-
|
|
6093
|
+
translated?: string | null;
|
|
6110
6094
|
}
|
|
6111
|
-
|
|
6112
|
-
declare enum RefundStatus {
|
|
6113
|
-
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
6114
|
-
PENDING = "PENDING",
|
|
6115
|
-
/** Refund transaction succeeded. */
|
|
6116
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6117
|
-
/** Refund transaction failed. */
|
|
6118
|
-
FAILED = "FAILED",
|
|
6119
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
6120
|
-
SCHEDULED = "SCHEDULED",
|
|
6121
|
-
/** Refund was initiated on payment provider side. */
|
|
6122
|
-
STARTED = "STARTED"
|
|
6095
|
+
interface ChargeMembershipsResponse {
|
|
6123
6096
|
}
|
|
6124
|
-
|
|
6125
|
-
|
|
6126
|
-
|
|
6097
|
+
interface TriggerRefundRequest {
|
|
6098
|
+
/**
|
|
6099
|
+
* The order this refund related to
|
|
6100
|
+
* @minLength 1
|
|
6101
|
+
* @maxLength 100
|
|
6102
|
+
*/
|
|
6103
|
+
ecomOrderId: string;
|
|
6104
|
+
/**
|
|
6105
|
+
* Refund operations information
|
|
6106
|
+
* @minSize 1
|
|
6107
|
+
* @maxSize 1
|
|
6108
|
+
*/
|
|
6109
|
+
payments: PaymentRefund[];
|
|
6110
|
+
/** Business model of a refund */
|
|
6111
|
+
details?: RefundDetails;
|
|
6112
|
+
/** Side effect details related to refund */
|
|
6113
|
+
sideEffects?: RefundSideEffects;
|
|
6114
|
+
}
|
|
6115
|
+
interface PaymentRefund {
|
|
6116
|
+
/**
|
|
6117
|
+
* Specific payment within the order to refund
|
|
6118
|
+
* @format GUID
|
|
6119
|
+
*/
|
|
6120
|
+
paymentId?: string;
|
|
6121
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
6122
|
+
amount?: Price;
|
|
6127
6123
|
/**
|
|
6128
|
-
*
|
|
6129
|
-
*
|
|
6130
|
-
*
|
|
6124
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
6125
|
+
* 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.
|
|
6126
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
6127
|
+
*/
|
|
6128
|
+
externalRefund?: boolean;
|
|
6129
|
+
/**
|
|
6130
|
+
* Gateway refund id. When param is present, new refund is not created.
|
|
6131
|
+
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
6132
|
+
* and all side effects from request will be executed.
|
|
6133
|
+
* @internal
|
|
6131
6134
|
* @minLength 1
|
|
6132
|
-
* @maxLength
|
|
6135
|
+
* @maxLength 100
|
|
6133
6136
|
*/
|
|
6134
|
-
|
|
6137
|
+
gatewayRefundId?: string | null;
|
|
6138
|
+
}
|
|
6139
|
+
interface RefundSideEffects {
|
|
6140
|
+
/** Inventory restock details as part of this refund. */
|
|
6141
|
+
restockInfo?: RestockInfo;
|
|
6142
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
6143
|
+
sendOrderRefundedEmail?: boolean;
|
|
6135
6144
|
/**
|
|
6136
|
-
*
|
|
6145
|
+
* Custom message added to the refund confirmation email.
|
|
6137
6146
|
* @minLength 1
|
|
6138
6147
|
* @maxLength 1000
|
|
6139
6148
|
*/
|
|
6140
|
-
|
|
6141
|
-
}
|
|
6142
|
-
interface AggregatedRefundSummary {
|
|
6143
|
-
/** Total amount requested for refund. */
|
|
6144
|
-
requestedRefund?: Price;
|
|
6145
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
6146
|
-
pendingRefund?: Price;
|
|
6147
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
6148
|
-
refunded?: Price;
|
|
6149
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6150
|
-
failedRefundAmount?: Price;
|
|
6151
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6152
|
-
pending?: boolean;
|
|
6153
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6154
|
-
breakdown?: RefundItemsBreakdown;
|
|
6149
|
+
customMessage?: string | null;
|
|
6155
6150
|
}
|
|
6156
|
-
interface
|
|
6151
|
+
interface RestockInfo {
|
|
6152
|
+
/** Restock type. */
|
|
6153
|
+
type?: RestockTypeWithLiterals;
|
|
6157
6154
|
/**
|
|
6158
|
-
*
|
|
6155
|
+
* Deprecated, use items instead
|
|
6156
|
+
* @internal
|
|
6159
6157
|
* @maxSize 300
|
|
6158
|
+
* @deprecated
|
|
6160
6159
|
*/
|
|
6161
|
-
|
|
6160
|
+
lineItemIds?: string[];
|
|
6161
|
+
/**
|
|
6162
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
6163
|
+
* @maxSize 300
|
|
6164
|
+
*/
|
|
6165
|
+
items?: RestockItem[];
|
|
6162
6166
|
}
|
|
6163
|
-
|
|
6167
|
+
declare enum RestockType {
|
|
6168
|
+
NO_ITEMS = "NO_ITEMS",
|
|
6169
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
6170
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
6171
|
+
}
|
|
6172
|
+
/** @enumType */
|
|
6173
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
6174
|
+
interface RestockItem {
|
|
6164
6175
|
/**
|
|
6165
|
-
* ID of the
|
|
6176
|
+
* ID of the line item being restocked.
|
|
6166
6177
|
* @format GUID
|
|
6167
6178
|
*/
|
|
6168
6179
|
lineItemId?: string;
|
|
6169
|
-
/** Total refunded amount for the line item. */
|
|
6170
|
-
totalRefundedAmount?: Price;
|
|
6171
|
-
}
|
|
6172
|
-
interface CalculateRefundRequest {
|
|
6173
6180
|
/**
|
|
6174
|
-
*
|
|
6175
|
-
* @
|
|
6176
|
-
* @
|
|
6181
|
+
* Line item quantity being restocked.
|
|
6182
|
+
* @min 1
|
|
6183
|
+
* @max 100000
|
|
6177
6184
|
*/
|
|
6178
|
-
|
|
6185
|
+
quantity?: number;
|
|
6179
6186
|
/**
|
|
6180
|
-
*
|
|
6181
|
-
* @
|
|
6187
|
+
* Per-location breakdown of restock quantities.
|
|
6188
|
+
* @internal
|
|
6189
|
+
* @maxSize 5
|
|
6182
6190
|
*/
|
|
6183
|
-
|
|
6184
|
-
/** Should include shipping in refund calculation */
|
|
6185
|
-
refundShipping?: boolean;
|
|
6191
|
+
restockLocations?: RestockLocation[];
|
|
6186
6192
|
}
|
|
6187
|
-
interface
|
|
6193
|
+
interface TriggerRefundResponse {
|
|
6194
|
+
/** All order's transactions after the refunds were added */
|
|
6195
|
+
orderTransactions?: OrderTransactions;
|
|
6196
|
+
/** Created refund ID */
|
|
6197
|
+
refundId?: string | null;
|
|
6198
|
+
/** Payment ID's that the refund execution had failed for */
|
|
6199
|
+
failedPaymentIds?: ItemMetadata[];
|
|
6200
|
+
}
|
|
6201
|
+
/**
|
|
6202
|
+
* A record of all payments and refunds associated with an order.
|
|
6203
|
+
*
|
|
6204
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
6205
|
+
*/
|
|
6206
|
+
interface OrderTransactions {
|
|
6188
6207
|
/**
|
|
6189
|
-
* ID
|
|
6208
|
+
* Order ID.
|
|
6190
6209
|
* @format GUID
|
|
6191
6210
|
*/
|
|
6192
|
-
|
|
6211
|
+
orderId?: string;
|
|
6193
6212
|
/**
|
|
6194
|
-
*
|
|
6195
|
-
* @
|
|
6196
|
-
* @max 100000
|
|
6213
|
+
* Record of payments made to the merchant.
|
|
6214
|
+
* @maxSize 100
|
|
6197
6215
|
*/
|
|
6198
|
-
|
|
6199
|
-
}
|
|
6200
|
-
interface CalculateRefundResponse {
|
|
6201
|
-
/** Total refundable amount */
|
|
6202
|
-
total?: Price;
|
|
6203
|
-
/** Tax cost of the order */
|
|
6204
|
-
tax?: Price;
|
|
6205
|
-
/** Discount given for this order */
|
|
6206
|
-
discount?: Price;
|
|
6207
|
-
/** Total cost of the order (without tax) */
|
|
6208
|
-
subtotal?: Price;
|
|
6209
|
-
/** Total shipping cost for order */
|
|
6210
|
-
shipping?: Price;
|
|
6211
|
-
/** Previous refund given on that order */
|
|
6212
|
-
previouslyRefundedAmount?: Price;
|
|
6216
|
+
payments?: Payment[];
|
|
6213
6217
|
/**
|
|
6214
|
-
*
|
|
6218
|
+
* Record of refunds made to the buyer.
|
|
6215
6219
|
* @maxSize 300
|
|
6216
6220
|
*/
|
|
6217
|
-
|
|
6221
|
+
refunds?: Refund[];
|
|
6218
6222
|
}
|
|
6219
|
-
interface
|
|
6223
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
6224
|
+
/** Regular payment details. */
|
|
6225
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
6226
|
+
/** Gift card payment details. */
|
|
6227
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
6228
|
+
/** Membership payment details. */
|
|
6229
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
6220
6230
|
/**
|
|
6221
|
-
*
|
|
6231
|
+
* Receipt created by Wix
|
|
6232
|
+
* @internal
|
|
6233
|
+
*/
|
|
6234
|
+
wixReceipt?: WixReceiptInfo;
|
|
6235
|
+
/**
|
|
6236
|
+
* Receipt created by an external system.
|
|
6237
|
+
* @internal
|
|
6238
|
+
*/
|
|
6239
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
6240
|
+
/** @internal */
|
|
6241
|
+
canceled?: CanceledStatusDetails;
|
|
6242
|
+
/** @internal */
|
|
6243
|
+
declined?: DeclinedStatusDetails;
|
|
6244
|
+
/** @internal */
|
|
6245
|
+
voided?: VoidedStatusDetails;
|
|
6246
|
+
/**
|
|
6247
|
+
* Payment ID.
|
|
6222
6248
|
* @format GUID
|
|
6249
|
+
* @readonly
|
|
6223
6250
|
*/
|
|
6224
|
-
id?: string;
|
|
6225
|
-
/**
|
|
6226
|
-
|
|
6227
|
-
}
|
|
6228
|
-
interface VoidAuthorizedPaymentsRequest {
|
|
6251
|
+
id?: string | null;
|
|
6252
|
+
/** 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. */
|
|
6253
|
+
createdDate?: Date | null;
|
|
6229
6254
|
/**
|
|
6230
|
-
*
|
|
6231
|
-
* @
|
|
6232
|
-
* @maxLength 100
|
|
6255
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
6256
|
+
* @readonly
|
|
6233
6257
|
*/
|
|
6234
|
-
|
|
6258
|
+
updatedDate?: Date | null;
|
|
6259
|
+
/** Payment amount. */
|
|
6260
|
+
amount?: Price;
|
|
6235
6261
|
/**
|
|
6236
|
-
*
|
|
6237
|
-
*
|
|
6238
|
-
*
|
|
6262
|
+
* Whether refunds for this payment are disabled.
|
|
6263
|
+
* + `true`: This payment is not refundable.
|
|
6264
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
6265
|
+
*/
|
|
6266
|
+
refundDisabled?: boolean;
|
|
6267
|
+
/**
|
|
6268
|
+
* Whether receipt generation is allowed for this payment.
|
|
6269
|
+
* + `true`: This payment supports receipt generation.
|
|
6270
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
6271
|
+
* @readonly
|
|
6272
|
+
*/
|
|
6273
|
+
supportReceiptGeneration?: boolean;
|
|
6274
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
6275
|
+
cashRounding?: CashRoundingDetails;
|
|
6276
|
+
/**
|
|
6277
|
+
* Overall payment status.
|
|
6278
|
+
*
|
|
6279
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
6280
|
+
*/
|
|
6281
|
+
status?: PaymentStatusWithLiterals;
|
|
6282
|
+
/**
|
|
6283
|
+
* Detailed payment status information including gateway reason codes and status-specific details.
|
|
6284
|
+
* @internal
|
|
6285
|
+
*/
|
|
6286
|
+
paymentStatusDetails?: PaymentStatusDetails;
|
|
6287
|
+
/**
|
|
6288
|
+
* Location where the payment was processed.
|
|
6289
|
+
* @internal
|
|
6239
6290
|
* @format GUID
|
|
6291
|
+
* @immutable
|
|
6240
6292
|
*/
|
|
6241
|
-
|
|
6293
|
+
locationId?: string | null;
|
|
6294
|
+
/**
|
|
6295
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
6296
|
+
* @format GUID
|
|
6297
|
+
*/
|
|
6298
|
+
chargeCorrelationId?: string | null;
|
|
6242
6299
|
}
|
|
6243
|
-
|
|
6244
|
-
|
|
6245
|
-
|
|
6300
|
+
/** @oneof */
|
|
6301
|
+
interface PaymentPaymentDetailsOneOf {
|
|
6302
|
+
/** Regular payment details. */
|
|
6303
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
6304
|
+
/** Gift card payment details. */
|
|
6305
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
6306
|
+
/** Membership payment details. */
|
|
6307
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
6246
6308
|
}
|
|
6247
|
-
|
|
6309
|
+
/** @oneof */
|
|
6310
|
+
interface PaymentReceiptInfoOneOf {
|
|
6248
6311
|
/**
|
|
6249
|
-
*
|
|
6250
|
-
* @
|
|
6251
|
-
* @maxLength 100
|
|
6312
|
+
* Receipt created by Wix
|
|
6313
|
+
* @internal
|
|
6252
6314
|
*/
|
|
6253
|
-
|
|
6315
|
+
wixReceipt?: WixReceiptInfo;
|
|
6316
|
+
/**
|
|
6317
|
+
* Receipt created by an external system.
|
|
6318
|
+
* @internal
|
|
6319
|
+
*/
|
|
6320
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
6321
|
+
}
|
|
6322
|
+
/** @oneof */
|
|
6323
|
+
interface PaymentStatusDetailsOneOf {
|
|
6324
|
+
/** @internal */
|
|
6325
|
+
canceled?: CanceledStatusDetails;
|
|
6326
|
+
/** @internal */
|
|
6327
|
+
declined?: DeclinedStatusDetails;
|
|
6328
|
+
/** @internal */
|
|
6329
|
+
voided?: VoidedStatusDetails;
|
|
6330
|
+
}
|
|
6331
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
6332
|
+
/** Credit card details. */
|
|
6333
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
6254
6334
|
/**
|
|
6255
|
-
*
|
|
6256
|
-
* @
|
|
6257
|
-
* @maxSize 100
|
|
6335
|
+
* Wix Payments order ID.
|
|
6336
|
+
* @maxLength 100
|
|
6258
6337
|
*/
|
|
6259
|
-
|
|
6260
|
-
}
|
|
6261
|
-
interface PaymentCapture {
|
|
6338
|
+
paymentOrderId?: string | null;
|
|
6262
6339
|
/**
|
|
6263
|
-
* Payment ID
|
|
6264
|
-
*
|
|
6340
|
+
* Payment gateway's transaction ID.
|
|
6341
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
6342
|
+
* @maxLength 100
|
|
6265
6343
|
*/
|
|
6266
|
-
|
|
6344
|
+
gatewayTransactionId?: string | null;
|
|
6267
6345
|
/**
|
|
6268
|
-
*
|
|
6269
|
-
*
|
|
6346
|
+
* Payment method.
|
|
6347
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
6348
|
+
* Non-exhaustive list of supported values:
|
|
6349
|
+
* + `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`
|
|
6350
|
+
* @maxLength 150
|
|
6351
|
+
* @deprecated Payment method.
|
|
6352
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
6353
|
+
* Non-exhaustive list of supported values:
|
|
6354
|
+
* + `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`
|
|
6355
|
+
* @replacedBy payment_method_name
|
|
6356
|
+
* @targetRemovalDate 2026-07-01
|
|
6270
6357
|
*/
|
|
6271
|
-
|
|
6272
|
-
}
|
|
6273
|
-
interface CaptureAuthorizedPaymentsResponse {
|
|
6274
|
-
/** All order's transactions after the capture was triggered */
|
|
6275
|
-
orderTransactions?: OrderTransactions;
|
|
6276
|
-
}
|
|
6277
|
-
interface ChargeSavedPaymentMethodRequest {
|
|
6358
|
+
paymentMethod?: string | null;
|
|
6278
6359
|
/**
|
|
6279
|
-
*
|
|
6280
|
-
* @minLength 1
|
|
6360
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
6281
6361
|
* @maxLength 100
|
|
6282
6362
|
*/
|
|
6283
|
-
|
|
6284
|
-
/**
|
|
6285
|
-
|
|
6286
|
-
}
|
|
6287
|
-
interface ChargeSavedPaymentMethodResponse {
|
|
6288
|
-
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
6289
|
-
paymentGatewayOrderId?: string;
|
|
6290
|
-
}
|
|
6291
|
-
interface SendBuyerConfirmationEmailRequest {
|
|
6292
|
-
/** @format GUID */
|
|
6293
|
-
orderId?: string;
|
|
6294
|
-
}
|
|
6295
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
6296
|
-
}
|
|
6297
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
6363
|
+
providerTransactionId?: string | null;
|
|
6364
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
6365
|
+
offlinePayment?: boolean;
|
|
6298
6366
|
/**
|
|
6299
|
-
*
|
|
6300
|
-
* @
|
|
6367
|
+
* Payment status.
|
|
6368
|
+
* @deprecated Payment status.
|
|
6369
|
+
* @replacedBy payment.status
|
|
6370
|
+
* @targetRemovalDate 2026-11-01
|
|
6301
6371
|
*/
|
|
6302
|
-
|
|
6303
|
-
|
|
6304
|
-
|
|
6305
|
-
|
|
6306
|
-
|
|
6372
|
+
status?: TransactionStatusWithLiterals;
|
|
6373
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
6374
|
+
savedPaymentMethod?: boolean;
|
|
6375
|
+
/** Authorization details. */
|
|
6376
|
+
authorizationDetails?: AuthorizationDetails;
|
|
6307
6377
|
/**
|
|
6308
|
-
*
|
|
6309
|
-
* @
|
|
6378
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
6379
|
+
* @internal
|
|
6380
|
+
* @maxLength 300
|
|
6310
6381
|
*/
|
|
6311
|
-
|
|
6312
|
-
}
|
|
6313
|
-
interface SendBuyerPickupConfirmationEmailResponse {
|
|
6314
|
-
}
|
|
6315
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
6382
|
+
paymentProvider?: string | null;
|
|
6316
6383
|
/**
|
|
6317
|
-
*
|
|
6318
|
-
* @
|
|
6319
|
-
* @maxSize 300
|
|
6384
|
+
* Record of chargebacks made by the buyer.
|
|
6385
|
+
* @maxSize 6
|
|
6320
6386
|
*/
|
|
6321
|
-
|
|
6322
|
-
}
|
|
6323
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
6324
|
-
}
|
|
6325
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
6387
|
+
chargebacks?: Chargeback[];
|
|
6326
6388
|
/**
|
|
6327
|
-
*
|
|
6328
|
-
* @
|
|
6389
|
+
* Payment method ID.
|
|
6390
|
+
* @internal
|
|
6391
|
+
* @maxLength 36
|
|
6329
6392
|
*/
|
|
6330
|
-
|
|
6331
|
-
|
|
6332
|
-
|
|
6333
|
-
}
|
|
6334
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
6393
|
+
paymentMethodId?: string | null;
|
|
6394
|
+
/** Platform fee amount associated with this payment. */
|
|
6395
|
+
platformFee?: Price;
|
|
6335
6396
|
/**
|
|
6336
|
-
*
|
|
6337
|
-
*
|
|
6338
|
-
*
|
|
6397
|
+
* Payment method with buyer and optional owner translations.
|
|
6398
|
+
* Non-exhaustive list of supported values:
|
|
6399
|
+
* + `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`
|
|
6339
6400
|
*/
|
|
6340
|
-
|
|
6401
|
+
paymentMethodName?: PaymentMethodName;
|
|
6341
6402
|
}
|
|
6342
|
-
|
|
6403
|
+
/** @oneof */
|
|
6404
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
6405
|
+
/** Credit card details. */
|
|
6406
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
6343
6407
|
}
|
|
6344
|
-
|
|
6408
|
+
declare enum TransactionStatus {
|
|
6409
|
+
UNDEFINED = "UNDEFINED",
|
|
6410
|
+
APPROVED = "APPROVED",
|
|
6411
|
+
PENDING = "PENDING",
|
|
6412
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6413
|
+
CANCELED = "CANCELED",
|
|
6414
|
+
DECLINED = "DECLINED",
|
|
6415
|
+
REFUNDED = "REFUNDED",
|
|
6416
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6417
|
+
AUTHORIZED = "AUTHORIZED",
|
|
6418
|
+
VOIDED = "VOIDED"
|
|
6419
|
+
}
|
|
6420
|
+
/** @enumType */
|
|
6421
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6422
|
+
interface CreditCardPaymentMethodDetails {
|
|
6345
6423
|
/**
|
|
6346
|
-
*
|
|
6347
|
-
* @maxLength
|
|
6424
|
+
* The last 4 digits of the card number.
|
|
6425
|
+
* @maxLength 4
|
|
6348
6426
|
*/
|
|
6349
|
-
|
|
6350
|
-
}
|
|
6351
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
6352
|
-
}
|
|
6353
|
-
interface SendCancelRefundEmailRequest {
|
|
6427
|
+
lastFourDigits?: string | null;
|
|
6354
6428
|
/**
|
|
6355
|
-
*
|
|
6356
|
-
* @minLength 1
|
|
6429
|
+
* Card issuer's brand.
|
|
6357
6430
|
* @maxLength 100
|
|
6358
6431
|
*/
|
|
6359
|
-
|
|
6432
|
+
brand?: string | null;
|
|
6433
|
+
}
|
|
6434
|
+
interface AuthorizationDetails {
|
|
6360
6435
|
/**
|
|
6361
|
-
*
|
|
6362
|
-
* @
|
|
6363
|
-
* @maxLength 1000
|
|
6436
|
+
* Whether the authorized payment is of a delayed capture.
|
|
6437
|
+
* @readonly
|
|
6364
6438
|
*/
|
|
6365
|
-
|
|
6366
|
-
/**
|
|
6367
|
-
|
|
6439
|
+
delayedCapture?: boolean;
|
|
6440
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6441
|
+
authorizedDate?: Date | null;
|
|
6368
6442
|
/**
|
|
6369
|
-
*
|
|
6370
|
-
*
|
|
6443
|
+
* List of captures associated with payment
|
|
6444
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
6445
|
+
* @maxSize 1
|
|
6371
6446
|
*/
|
|
6372
|
-
|
|
6373
|
-
|
|
6374
|
-
|
|
6447
|
+
captures?: AuthorizationCapture[];
|
|
6448
|
+
/** Void associated with payment */
|
|
6449
|
+
void?: AuthorizationVoid;
|
|
6450
|
+
/** Scheduled action for this transaction */
|
|
6451
|
+
scheduledAction?: V1ScheduledAction;
|
|
6375
6452
|
}
|
|
6376
|
-
interface
|
|
6377
|
-
/**
|
|
6378
|
-
* The ID of order that is refunded
|
|
6379
|
-
* @format GUID
|
|
6380
|
-
*/
|
|
6381
|
-
orderId?: string;
|
|
6453
|
+
interface AuthorizationCapture {
|
|
6382
6454
|
/**
|
|
6383
|
-
*
|
|
6455
|
+
* Capture ID.
|
|
6384
6456
|
* @format GUID
|
|
6457
|
+
* @readonly
|
|
6385
6458
|
*/
|
|
6386
|
-
|
|
6459
|
+
id?: string | null;
|
|
6460
|
+
/** Status of this capture action */
|
|
6461
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
6387
6462
|
/**
|
|
6388
|
-
*
|
|
6389
|
-
* @
|
|
6390
|
-
* @maxLength 1000
|
|
6463
|
+
* Amount of this capture
|
|
6464
|
+
* @immutable
|
|
6391
6465
|
*/
|
|
6392
|
-
|
|
6466
|
+
amount?: Price;
|
|
6467
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6468
|
+
createdDate?: Date | null;
|
|
6469
|
+
/** In case of status is FAILED may contain failure details */
|
|
6470
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
6393
6471
|
}
|
|
6394
|
-
|
|
6472
|
+
declare enum AuthorizationCaptureStatus {
|
|
6473
|
+
/** Capture operation still in progress. */
|
|
6474
|
+
PENDING = "PENDING",
|
|
6475
|
+
/** Capture operation succeeded. */
|
|
6476
|
+
SUCCEEDED = "SUCCEEDED",
|
|
6477
|
+
/** Capture operation failed. */
|
|
6478
|
+
FAILED = "FAILED"
|
|
6395
6479
|
}
|
|
6396
|
-
|
|
6397
|
-
|
|
6398
|
-
|
|
6399
|
-
/** @
|
|
6400
|
-
|
|
6480
|
+
/** @enumType */
|
|
6481
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
6482
|
+
interface AuthorizationActionFailureDetails {
|
|
6483
|
+
/** @maxLength 100 */
|
|
6484
|
+
failureCode?: string;
|
|
6401
6485
|
}
|
|
6402
|
-
interface
|
|
6486
|
+
interface AuthorizationVoid {
|
|
6487
|
+
/** Status of this void action */
|
|
6488
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
6489
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6490
|
+
voidedDate?: Date | null;
|
|
6491
|
+
/** In case of status is FAILED may contain failure details */
|
|
6492
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
6493
|
+
/** Reason of void action */
|
|
6494
|
+
reason?: ReasonWithLiterals;
|
|
6403
6495
|
}
|
|
6404
|
-
|
|
6405
|
-
/**
|
|
6406
|
-
|
|
6407
|
-
|
|
6408
|
-
|
|
6409
|
-
|
|
6496
|
+
declare enum AuthorizationVoidStatus {
|
|
6497
|
+
/** Void operation still in progress. */
|
|
6498
|
+
PENDING = "PENDING",
|
|
6499
|
+
/** Void operation succeeded. */
|
|
6500
|
+
SUCCEEDED = "SUCCEEDED",
|
|
6501
|
+
/** Void operation failed. */
|
|
6502
|
+
FAILED = "FAILED"
|
|
6410
6503
|
}
|
|
6411
|
-
|
|
6504
|
+
/** @enumType */
|
|
6505
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
6506
|
+
/** Reason the authorization was voided. */
|
|
6507
|
+
declare enum Reason {
|
|
6508
|
+
/** Authorization was voided by user. */
|
|
6509
|
+
MANUAL = "MANUAL",
|
|
6510
|
+
/** Authorization passed execution date. */
|
|
6511
|
+
SCHEDULED = "SCHEDULED"
|
|
6412
6512
|
}
|
|
6413
|
-
|
|
6414
|
-
|
|
6513
|
+
/** @enumType */
|
|
6514
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
6515
|
+
interface V1ScheduledAction {
|
|
6516
|
+
/** Type of the action. */
|
|
6517
|
+
actionType?: ActionTypeWithLiterals;
|
|
6518
|
+
/** The date and time of the action. */
|
|
6519
|
+
executionDate?: Date | null;
|
|
6415
6520
|
}
|
|
6416
|
-
declare enum
|
|
6417
|
-
|
|
6418
|
-
|
|
6419
|
-
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
6420
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
6521
|
+
declare enum ActionType {
|
|
6522
|
+
VOID = "VOID",
|
|
6523
|
+
CAPTURE = "CAPTURE"
|
|
6421
6524
|
}
|
|
6422
6525
|
/** @enumType */
|
|
6423
|
-
type
|
|
6424
|
-
interface
|
|
6425
|
-
emailPreview?: string;
|
|
6426
|
-
}
|
|
6427
|
-
interface PreviewRefundEmailRequest {
|
|
6428
|
-
/**
|
|
6429
|
-
* @minLength 1
|
|
6430
|
-
* @maxLength 100
|
|
6431
|
-
*/
|
|
6432
|
-
orderId?: string;
|
|
6433
|
-
/** Refund amount */
|
|
6434
|
-
refundAmount?: Price;
|
|
6435
|
-
/** Refund business details */
|
|
6436
|
-
details?: RefundDetails;
|
|
6526
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
6527
|
+
interface Chargeback {
|
|
6437
6528
|
/**
|
|
6438
|
-
*
|
|
6439
|
-
* @
|
|
6440
|
-
* @
|
|
6529
|
+
* Chargeback ID.
|
|
6530
|
+
* @format GUID
|
|
6531
|
+
* @readonly
|
|
6532
|
+
* @immutable
|
|
6441
6533
|
*/
|
|
6442
|
-
|
|
6534
|
+
id?: string;
|
|
6443
6535
|
/**
|
|
6444
|
-
*
|
|
6445
|
-
* @
|
|
6536
|
+
* 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.
|
|
6537
|
+
* @readonly
|
|
6538
|
+
* @immutable
|
|
6446
6539
|
*/
|
|
6447
|
-
|
|
6448
|
-
}
|
|
6449
|
-
interface PreviewRefundEmailResponse {
|
|
6450
|
-
emailPreview?: string;
|
|
6451
|
-
}
|
|
6452
|
-
interface PreviewCancelEmailRequest {
|
|
6540
|
+
createdDate?: Date | null;
|
|
6453
6541
|
/**
|
|
6454
|
-
*
|
|
6455
|
-
* @
|
|
6542
|
+
* 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.
|
|
6543
|
+
* @readonly
|
|
6456
6544
|
*/
|
|
6457
|
-
|
|
6545
|
+
updatedDate?: Date | null;
|
|
6458
6546
|
/**
|
|
6459
|
-
*
|
|
6460
|
-
* @
|
|
6461
|
-
* @
|
|
6547
|
+
* Amount.
|
|
6548
|
+
* @readonly
|
|
6549
|
+
* @immutable
|
|
6462
6550
|
*/
|
|
6463
|
-
|
|
6464
|
-
}
|
|
6465
|
-
interface PreviewCancelEmailResponse {
|
|
6466
|
-
emailPreview?: string;
|
|
6467
|
-
}
|
|
6468
|
-
interface PreviewCancelRefundEmailRequest {
|
|
6551
|
+
amount?: Price;
|
|
6469
6552
|
/**
|
|
6470
|
-
*
|
|
6471
|
-
* @
|
|
6553
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
6554
|
+
* @readonly
|
|
6472
6555
|
*/
|
|
6473
|
-
|
|
6556
|
+
reversalAmount?: Price;
|
|
6474
6557
|
/**
|
|
6475
|
-
*
|
|
6476
|
-
*
|
|
6477
|
-
*
|
|
6558
|
+
* Status.
|
|
6559
|
+
*
|
|
6560
|
+
* Default: `"APPROVED"`.
|
|
6478
6561
|
*/
|
|
6479
|
-
|
|
6480
|
-
/** Refund amount */
|
|
6481
|
-
refundAmount?: Price;
|
|
6562
|
+
status?: ChargebackStatusWithLiterals;
|
|
6482
6563
|
/**
|
|
6483
|
-
*
|
|
6564
|
+
* External chargeback ID.
|
|
6484
6565
|
* @format GUID
|
|
6566
|
+
* @readonly
|
|
6567
|
+
* @immutable
|
|
6485
6568
|
*/
|
|
6486
|
-
|
|
6487
|
-
}
|
|
6488
|
-
interface PreviewCancelRefundEmailResponse {
|
|
6489
|
-
emailPreview?: string;
|
|
6490
|
-
}
|
|
6491
|
-
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
6492
|
-
}
|
|
6493
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
6494
|
-
emailPreview?: string;
|
|
6495
|
-
}
|
|
6496
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
6497
|
-
}
|
|
6498
|
-
interface PreviewBuyerConfirmationEmailResponse {
|
|
6499
|
-
emailPreview?: string;
|
|
6500
|
-
}
|
|
6501
|
-
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
6502
|
-
}
|
|
6503
|
-
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
6504
|
-
emailPreview?: string;
|
|
6505
|
-
}
|
|
6506
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
6507
|
-
}
|
|
6508
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
6509
|
-
emailPreview?: string;
|
|
6510
|
-
}
|
|
6511
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
6569
|
+
externalId?: string | null;
|
|
6512
6570
|
}
|
|
6513
|
-
|
|
6514
|
-
|
|
6571
|
+
declare enum ChargebackStatus {
|
|
6572
|
+
/** Chargeback was approved. */
|
|
6573
|
+
APPROVED = "APPROVED",
|
|
6574
|
+
/** Chargeback was reversed. */
|
|
6575
|
+
REVERSED = "REVERSED"
|
|
6515
6576
|
}
|
|
6516
|
-
|
|
6517
|
-
|
|
6518
|
-
|
|
6519
|
-
/** Emitted on a meta site transfer completion. */
|
|
6520
|
-
siteTransferred?: SiteTransferred;
|
|
6521
|
-
/** Emitted on a meta site deletion. */
|
|
6522
|
-
siteDeleted?: SiteDeleted;
|
|
6523
|
-
/** Emitted on a meta site restoration. */
|
|
6524
|
-
siteUndeleted?: SiteUndeleted;
|
|
6525
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6526
|
-
sitePublished?: SitePublished;
|
|
6527
|
-
/** Emitted on a meta site unpublish. */
|
|
6528
|
-
siteUnpublished?: SiteUnpublished;
|
|
6529
|
-
/** Emitted when meta site is marked as template. */
|
|
6530
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6531
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
6532
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6533
|
-
/** Emitted when an application is provisioned (installed). */
|
|
6534
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
6535
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
6536
|
-
serviceRemoved?: ServiceRemoved;
|
|
6537
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
6538
|
-
siteRenamedPayload?: SiteRenamed;
|
|
6539
|
-
/** Emitted when meta site was permanently deleted. */
|
|
6540
|
-
hardDeleted?: SiteHardDeleted;
|
|
6541
|
-
/** Emitted on a namespace change. */
|
|
6542
|
-
namespaceChanged?: NamespaceChanged;
|
|
6543
|
-
/** Emitted when Studio is attached. */
|
|
6544
|
-
studioAssigned?: StudioAssigned;
|
|
6545
|
-
/** Emitted when Studio is detached. */
|
|
6546
|
-
studioUnassigned?: StudioUnassigned;
|
|
6577
|
+
/** @enumType */
|
|
6578
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
6579
|
+
interface PaymentMethodName {
|
|
6547
6580
|
/**
|
|
6548
|
-
*
|
|
6549
|
-
*
|
|
6550
|
-
*
|
|
6551
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6552
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6581
|
+
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
6582
|
+
* @maxLength 150
|
|
6553
6583
|
*/
|
|
6554
|
-
|
|
6555
|
-
/** Site is marked as PurgedExternally */
|
|
6556
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
6557
|
-
/** Emitted when Odeditor is attached. */
|
|
6558
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
6559
|
-
/** Emitted when Odeditor is detached. */
|
|
6560
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
6561
|
-
/** Emitted when Picasso is attached. */
|
|
6562
|
-
picassoAssigned?: PicassoAssigned;
|
|
6563
|
-
/** Emitted when Picasso is detached. */
|
|
6564
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
6565
|
-
/** Emitted when Wixel is attached. */
|
|
6566
|
-
wixelAssigned?: WixelAssigned;
|
|
6567
|
-
/** Emitted when Wixel is detached. */
|
|
6568
|
-
wixelUnassigned?: WixelUnassigned;
|
|
6569
|
-
/** Emitted when StudioTwo is attached. */
|
|
6570
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
6571
|
-
/** Emitted when StudioTwo is detached. */
|
|
6572
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6573
|
-
/** Emitted when media from user domain is enabled. */
|
|
6574
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6575
|
-
/** Emitted when media from user domain is disabled. */
|
|
6576
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6577
|
-
/** Emitted when Editorless is attached. */
|
|
6578
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
6579
|
-
/** Emitted when Editorless is detached. */
|
|
6580
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
6584
|
+
buyerLanguageName?: string | null;
|
|
6581
6585
|
/**
|
|
6582
|
-
*
|
|
6583
|
-
*
|
|
6586
|
+
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
6587
|
+
*
|
|
6588
|
+
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
6589
|
+
* @maxLength 150
|
|
6584
6590
|
*/
|
|
6585
|
-
|
|
6586
|
-
/** A meta site version. Monotonically increasing. */
|
|
6587
|
-
version?: string;
|
|
6588
|
-
/** A timestamp of the event. */
|
|
6589
|
-
timestamp?: string;
|
|
6591
|
+
siteLanguageName?: string | null;
|
|
6590
6592
|
/**
|
|
6591
|
-
*
|
|
6592
|
-
*
|
|
6593
|
-
*
|
|
6593
|
+
* User-provided payment method name.
|
|
6594
|
+
*
|
|
6595
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
6594
6596
|
*/
|
|
6595
|
-
|
|
6597
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
6596
6598
|
}
|
|
6597
|
-
|
|
6598
|
-
|
|
6599
|
-
|
|
6600
|
-
|
|
6601
|
-
|
|
6602
|
-
|
|
6603
|
-
/**
|
|
6604
|
-
|
|
6605
|
-
|
|
6606
|
-
|
|
6607
|
-
|
|
6608
|
-
|
|
6609
|
-
/** Emitted on a meta site unpublish. */
|
|
6610
|
-
siteUnpublished?: SiteUnpublished;
|
|
6611
|
-
/** Emitted when meta site is marked as template. */
|
|
6612
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6613
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
6614
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6615
|
-
/** Emitted when an application is provisioned (installed). */
|
|
6616
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
6617
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
6618
|
-
serviceRemoved?: ServiceRemoved;
|
|
6619
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
6620
|
-
siteRenamedPayload?: SiteRenamed;
|
|
6621
|
-
/** Emitted when meta site was permanently deleted. */
|
|
6622
|
-
hardDeleted?: SiteHardDeleted;
|
|
6623
|
-
/** Emitted on a namespace change. */
|
|
6624
|
-
namespaceChanged?: NamespaceChanged;
|
|
6625
|
-
/** Emitted when Studio is attached. */
|
|
6626
|
-
studioAssigned?: StudioAssigned;
|
|
6627
|
-
/** Emitted when Studio is detached. */
|
|
6628
|
-
studioUnassigned?: StudioUnassigned;
|
|
6599
|
+
interface GiftCardPaymentDetails {
|
|
6600
|
+
/**
|
|
6601
|
+
* Gift card payment ID.
|
|
6602
|
+
* @maxLength 100
|
|
6603
|
+
*/
|
|
6604
|
+
giftCardPaymentId?: string;
|
|
6605
|
+
/**
|
|
6606
|
+
* Gift card ID.
|
|
6607
|
+
* @internal
|
|
6608
|
+
* @deprecated
|
|
6609
|
+
*/
|
|
6610
|
+
giftCardId?: string;
|
|
6629
6611
|
/**
|
|
6630
|
-
*
|
|
6631
|
-
*
|
|
6632
|
-
*
|
|
6633
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6634
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6612
|
+
* ID of the app that created the gift card.
|
|
6613
|
+
* @format GUID
|
|
6635
6614
|
*/
|
|
6636
|
-
|
|
6637
|
-
/** Site is marked as PurgedExternally */
|
|
6638
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
6639
|
-
/** Emitted when Odeditor is attached. */
|
|
6640
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
6641
|
-
/** Emitted when Odeditor is detached. */
|
|
6642
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
6643
|
-
/** Emitted when Picasso is attached. */
|
|
6644
|
-
picassoAssigned?: PicassoAssigned;
|
|
6645
|
-
/** Emitted when Picasso is detached. */
|
|
6646
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
6647
|
-
/** Emitted when Wixel is attached. */
|
|
6648
|
-
wixelAssigned?: WixelAssigned;
|
|
6649
|
-
/** Emitted when Wixel is detached. */
|
|
6650
|
-
wixelUnassigned?: WixelUnassigned;
|
|
6651
|
-
/** Emitted when StudioTwo is attached. */
|
|
6652
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
6653
|
-
/** Emitted when StudioTwo is detached. */
|
|
6654
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6655
|
-
/** Emitted when media from user domain is enabled. */
|
|
6656
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6657
|
-
/** Emitted when media from user domain is disabled. */
|
|
6658
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6659
|
-
/** Emitted when Editorless is attached. */
|
|
6660
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
6661
|
-
/** Emitted when Editorless is detached. */
|
|
6662
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
6663
|
-
}
|
|
6664
|
-
interface Asset {
|
|
6615
|
+
appId?: string;
|
|
6665
6616
|
/**
|
|
6666
|
-
*
|
|
6667
|
-
* @
|
|
6617
|
+
* Whether the gift card is voided.
|
|
6618
|
+
* @readonly
|
|
6619
|
+
* @deprecated Whether the gift card is voided.
|
|
6620
|
+
* @replacedBy payment.status
|
|
6621
|
+
* @targetRemovalDate 2026-11-01
|
|
6668
6622
|
*/
|
|
6669
|
-
|
|
6623
|
+
voided?: boolean;
|
|
6670
6624
|
/**
|
|
6671
|
-
*
|
|
6625
|
+
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
6626
|
+
* @maxLength 30
|
|
6627
|
+
* @immutable
|
|
6628
|
+
*/
|
|
6629
|
+
obfuscatedCode?: string | null;
|
|
6630
|
+
}
|
|
6631
|
+
interface MembershipPaymentDetails {
|
|
6632
|
+
/**
|
|
6633
|
+
* Membership ID.
|
|
6672
6634
|
* @maxLength 200
|
|
6673
6635
|
*/
|
|
6674
|
-
|
|
6675
|
-
/**
|
|
6676
|
-
|
|
6636
|
+
membershipId?: string;
|
|
6637
|
+
/**
|
|
6638
|
+
* ID of the line item this membership applies to.
|
|
6639
|
+
* @minLength 1
|
|
6640
|
+
* @maxLength 100
|
|
6641
|
+
*/
|
|
6642
|
+
lineItemId?: string;
|
|
6643
|
+
/**
|
|
6644
|
+
* Payment status.
|
|
6645
|
+
* @deprecated Payment status.
|
|
6646
|
+
* @replacedBy payment.status
|
|
6647
|
+
* @targetRemovalDate 2026-11-01
|
|
6648
|
+
*/
|
|
6649
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
6650
|
+
/** Membership name. */
|
|
6651
|
+
name?: MembershipName;
|
|
6652
|
+
/**
|
|
6653
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
6654
|
+
* @minLength 1
|
|
6655
|
+
* @maxLength 100
|
|
6656
|
+
*/
|
|
6657
|
+
externalTransactionId?: string | null;
|
|
6658
|
+
/**
|
|
6659
|
+
* Whether the membership is voided.
|
|
6660
|
+
* @readonly
|
|
6661
|
+
* @deprecated Whether the membership is voided.
|
|
6662
|
+
* @replacedBy payment.status
|
|
6663
|
+
* @targetRemovalDate 2026-11-01
|
|
6664
|
+
*/
|
|
6665
|
+
voided?: boolean;
|
|
6666
|
+
/**
|
|
6667
|
+
* ID of the application providing this payment option.
|
|
6668
|
+
* @format GUID
|
|
6669
|
+
*/
|
|
6670
|
+
providerAppId?: string;
|
|
6671
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
6672
|
+
futureMembership?: FutureMembershipDetails;
|
|
6677
6673
|
}
|
|
6678
|
-
declare enum
|
|
6679
|
-
|
|
6680
|
-
|
|
6681
|
-
|
|
6682
|
-
|
|
6683
|
-
|
|
6674
|
+
declare enum MembershipPaymentStatus {
|
|
6675
|
+
/** Payment was charged. */
|
|
6676
|
+
CHARGED = "CHARGED",
|
|
6677
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
6678
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6679
|
+
/** Payment is pending. */
|
|
6680
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
6681
|
+
/** Payment was voided. */
|
|
6682
|
+
VOIDED = "VOIDED"
|
|
6684
6683
|
}
|
|
6685
6684
|
/** @enumType */
|
|
6686
|
-
type
|
|
6687
|
-
interface
|
|
6685
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
6686
|
+
interface FutureMembershipDetails {
|
|
6688
6687
|
/**
|
|
6689
|
-
*
|
|
6690
|
-
* @
|
|
6688
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
6689
|
+
* @format GUID
|
|
6691
6690
|
*/
|
|
6692
|
-
|
|
6691
|
+
lineItemId?: string;
|
|
6693
6692
|
/**
|
|
6694
|
-
*
|
|
6695
|
-
* @
|
|
6693
|
+
* ID of the benefit the future membership will grant.
|
|
6694
|
+
* @maxLength 200
|
|
6696
6695
|
*/
|
|
6697
|
-
|
|
6698
|
-
|
|
6699
|
-
|
|
6696
|
+
benefitId?: string;
|
|
6697
|
+
}
|
|
6698
|
+
interface WixReceiptInfo {
|
|
6700
6699
|
/**
|
|
6701
|
-
*
|
|
6702
|
-
*
|
|
6703
|
-
* In case of a creation from a template it's a template id.
|
|
6704
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
6700
|
+
* Receipt ID
|
|
6705
6701
|
* @format GUID
|
|
6706
6702
|
*/
|
|
6707
|
-
|
|
6703
|
+
receiptId?: string;
|
|
6708
6704
|
/**
|
|
6709
|
-
*
|
|
6710
|
-
* @
|
|
6705
|
+
* Display number of receipt
|
|
6706
|
+
* @minLength 1
|
|
6707
|
+
* @maxLength 40
|
|
6711
6708
|
*/
|
|
6712
|
-
|
|
6713
|
-
/** A namespace. */
|
|
6714
|
-
namespace?: NamespaceWithLiterals;
|
|
6715
|
-
}
|
|
6716
|
-
declare enum SiteCreatedContext {
|
|
6717
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
6718
|
-
OTHER = "OTHER",
|
|
6719
|
-
/** A meta site was created from template. */
|
|
6720
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
6721
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
6722
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
6723
|
-
/** A copy of existing meta site. */
|
|
6724
|
-
DUPLICATE = "DUPLICATE",
|
|
6725
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
6726
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
6727
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
6728
|
-
FLASH = "FLASH"
|
|
6709
|
+
displayNumber?: string | null;
|
|
6729
6710
|
}
|
|
6730
|
-
|
|
6731
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
6732
|
-
declare enum Namespace {
|
|
6733
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
6734
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
6735
|
-
WIX = "WIX",
|
|
6736
|
-
/** 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. */
|
|
6737
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
6738
|
-
/** 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. */
|
|
6739
|
-
ALBUMS = "ALBUMS",
|
|
6740
|
-
/** 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. */
|
|
6741
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
6742
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6743
|
-
HOTELS = "HOTELS",
|
|
6744
|
-
/** 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. */
|
|
6745
|
-
CLUBS = "CLUBS",
|
|
6746
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6747
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
6711
|
+
interface ExternalReceiptInfo {
|
|
6748
6712
|
/**
|
|
6749
|
-
*
|
|
6750
|
-
*
|
|
6713
|
+
* External receipt ID
|
|
6714
|
+
* @maxLength 100
|
|
6751
6715
|
*/
|
|
6752
|
-
|
|
6753
|
-
/** 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. */
|
|
6754
|
-
LOGOS = "LOGOS",
|
|
6755
|
-
/** 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. */
|
|
6756
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
6757
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6758
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
6759
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6760
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
6716
|
+
receiptId?: string | null;
|
|
6761
6717
|
/**
|
|
6762
|
-
*
|
|
6763
|
-
*
|
|
6764
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
6718
|
+
* ID of the app providing the receipt
|
|
6719
|
+
* @format GUID
|
|
6765
6720
|
*/
|
|
6766
|
-
|
|
6721
|
+
appId?: string | null;
|
|
6767
6722
|
/**
|
|
6768
|
-
*
|
|
6769
|
-
*
|
|
6770
|
-
*
|
|
6723
|
+
* Display number of receipt
|
|
6724
|
+
* @minLength 1
|
|
6725
|
+
* @maxLength 40
|
|
6771
6726
|
*/
|
|
6772
|
-
|
|
6773
|
-
|
|
6774
|
-
|
|
6775
|
-
/** It is to be used in the Business First efforts. */
|
|
6776
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
6777
|
-
/** Bookings business flow with no site. */
|
|
6778
|
-
ANYWHERE = "ANYWHERE",
|
|
6779
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
6780
|
-
HEADLESS = "HEADLESS",
|
|
6727
|
+
displayNumber?: string | null;
|
|
6728
|
+
}
|
|
6729
|
+
interface CashRoundingDetails {
|
|
6781
6730
|
/**
|
|
6782
|
-
*
|
|
6783
|
-
*
|
|
6731
|
+
* Payment amount before cash rounding was applied.
|
|
6732
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
6733
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
6784
6734
|
*/
|
|
6785
|
-
|
|
6786
|
-
/**
|
|
6787
|
-
|
|
6735
|
+
unroundedAmount?: Price;
|
|
6736
|
+
/**
|
|
6737
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
6738
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
6739
|
+
* @readonly
|
|
6740
|
+
*/
|
|
6741
|
+
roundingAdjustment?: CashRounding;
|
|
6742
|
+
}
|
|
6743
|
+
declare enum PaymentStatus {
|
|
6744
|
+
/** Payment was charged successfully. */
|
|
6745
|
+
APPROVED = "APPROVED",
|
|
6746
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
6747
|
+
PENDING = "PENDING",
|
|
6748
|
+
/** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
|
|
6749
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6750
|
+
/** Payment was canceled before it was charged. */
|
|
6751
|
+
CANCELED = "CANCELED",
|
|
6752
|
+
/** Payment was declined by the payment provider. */
|
|
6753
|
+
DECLINED = "DECLINED",
|
|
6754
|
+
/** Payment was fully refunded. */
|
|
6755
|
+
REFUNDED = "REFUNDED",
|
|
6756
|
+
/** Part of the payment amount was refunded. */
|
|
6757
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6758
|
+
/** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
|
|
6759
|
+
AUTHORIZED = "AUTHORIZED",
|
|
6788
6760
|
/**
|
|
6789
|
-
*
|
|
6790
|
-
*
|
|
6791
|
-
*
|
|
6761
|
+
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
6762
|
+
*
|
|
6763
|
+
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
6792
6764
|
*/
|
|
6793
|
-
|
|
6794
|
-
|
|
6795
|
-
|
|
6765
|
+
VOIDED = "VOIDED"
|
|
6766
|
+
}
|
|
6767
|
+
/** @enumType */
|
|
6768
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6769
|
+
interface CanceledStatusDetails {
|
|
6770
|
+
reason?: CanceledReasonWithLiterals;
|
|
6771
|
+
}
|
|
6772
|
+
declare enum CanceledReason {
|
|
6773
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
6774
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
6775
|
+
/** Payment was not completed by user and expired. */
|
|
6776
|
+
EXPIRED = "EXPIRED"
|
|
6777
|
+
}
|
|
6778
|
+
/** @enumType */
|
|
6779
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
6780
|
+
interface DeclinedStatusDetails {
|
|
6781
|
+
reason?: DeclinedReasonWithLiterals;
|
|
6782
|
+
}
|
|
6783
|
+
declare enum DeclinedReason {
|
|
6784
|
+
/** Corresponding charge failed. */
|
|
6785
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6786
|
+
/** Payment details expired. */
|
|
6787
|
+
EXPIRED = "EXPIRED",
|
|
6788
|
+
/** Insufficient funds. */
|
|
6789
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6790
|
+
/** Gift card was disabled before charge was attempted. */
|
|
6791
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
6792
|
+
}
|
|
6793
|
+
/** @enumType */
|
|
6794
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6795
|
+
interface VoidedStatusDetails {
|
|
6796
|
+
reason?: VoidedReasonWithLiterals;
|
|
6797
|
+
}
|
|
6798
|
+
declare enum VoidedReason {
|
|
6799
|
+
/** Payment was voided by merchant request. */
|
|
6800
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
6801
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
6802
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
6803
|
+
}
|
|
6804
|
+
/** @enumType */
|
|
6805
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
6806
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
6807
|
+
/** @internal */
|
|
6808
|
+
canceled?: CanceledStatusDetails;
|
|
6809
|
+
/** @internal */
|
|
6810
|
+
declined?: DeclinedStatusDetails;
|
|
6811
|
+
/** @internal */
|
|
6812
|
+
voided?: VoidedStatusDetails;
|
|
6796
6813
|
/**
|
|
6797
|
-
*
|
|
6798
|
-
*
|
|
6814
|
+
* Reason code from the payment gateway.
|
|
6815
|
+
* @internal
|
|
6816
|
+
* @minLength 1
|
|
6817
|
+
* @maxLength 10
|
|
6799
6818
|
*/
|
|
6800
|
-
|
|
6801
|
-
|
|
6802
|
-
|
|
6803
|
-
|
|
6804
|
-
|
|
6819
|
+
paymentGatewayReasonCode?: string | null;
|
|
6820
|
+
}
|
|
6821
|
+
/** @oneof */
|
|
6822
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
6823
|
+
/** @internal */
|
|
6824
|
+
canceled?: CanceledStatusDetails;
|
|
6825
|
+
/** @internal */
|
|
6826
|
+
declined?: DeclinedStatusDetails;
|
|
6827
|
+
/** @internal */
|
|
6828
|
+
voided?: VoidedStatusDetails;
|
|
6829
|
+
}
|
|
6830
|
+
interface Refund {
|
|
6805
6831
|
/**
|
|
6806
|
-
*
|
|
6807
|
-
*
|
|
6832
|
+
* Refund ID.
|
|
6833
|
+
* @format GUID
|
|
6834
|
+
* @readonly
|
|
6808
6835
|
*/
|
|
6809
|
-
|
|
6810
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6811
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
6812
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6813
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
6814
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
6815
|
-
MIMIR = "MIMIR",
|
|
6816
|
-
/** Wix Twins platform. */
|
|
6817
|
-
TWINS = "TWINS",
|
|
6818
|
-
/** Wix Nano. */
|
|
6819
|
-
NANO = "NANO",
|
|
6820
|
-
/** Base44 headless sites. */
|
|
6821
|
-
BASE44 = "BASE44",
|
|
6822
|
-
/** Wix Channels Sites */
|
|
6823
|
-
CHANNELS = "CHANNELS",
|
|
6824
|
-
/** Nautilus platform. */
|
|
6825
|
-
NAUTILUS = "NAUTILUS",
|
|
6836
|
+
id?: string;
|
|
6826
6837
|
/**
|
|
6827
|
-
*
|
|
6828
|
-
*
|
|
6838
|
+
* List of transactions.
|
|
6839
|
+
* @maxSize 50
|
|
6829
6840
|
*/
|
|
6830
|
-
|
|
6831
|
-
/**
|
|
6832
|
-
|
|
6841
|
+
transactions?: RefundTransaction[];
|
|
6842
|
+
/** Refund business details. */
|
|
6843
|
+
details?: RefundDetails;
|
|
6833
6844
|
/**
|
|
6834
|
-
*
|
|
6835
|
-
*
|
|
6845
|
+
* 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.
|
|
6846
|
+
* @readonly
|
|
6847
|
+
* @immutable
|
|
6836
6848
|
*/
|
|
6837
|
-
|
|
6849
|
+
createdDate?: Date | null;
|
|
6838
6850
|
/**
|
|
6839
|
-
*
|
|
6840
|
-
*
|
|
6841
|
-
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
6842
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6851
|
+
* Aggregated refund summary.
|
|
6852
|
+
* @readonly
|
|
6843
6853
|
*/
|
|
6844
|
-
|
|
6854
|
+
summary?: AggregatedRefundSummary;
|
|
6845
6855
|
/**
|
|
6846
|
-
*
|
|
6847
|
-
*
|
|
6856
|
+
* ID of the app that initiated this refund.
|
|
6857
|
+
* @format GUID
|
|
6858
|
+
* @readonly
|
|
6859
|
+
* @immutable
|
|
6848
6860
|
*/
|
|
6849
|
-
|
|
6861
|
+
requestingServiceAppId?: string | null;
|
|
6850
6862
|
}
|
|
6851
|
-
|
|
6852
|
-
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' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
|
|
6853
|
-
/** Site transferred to another user. */
|
|
6854
|
-
interface SiteTransferred {
|
|
6863
|
+
interface RefundTransaction {
|
|
6855
6864
|
/**
|
|
6856
|
-
*
|
|
6865
|
+
* ID of the payment associated with this refund.
|
|
6857
6866
|
* @format GUID
|
|
6867
|
+
* @immutable
|
|
6858
6868
|
*/
|
|
6859
|
-
|
|
6869
|
+
paymentId?: string;
|
|
6860
6870
|
/**
|
|
6861
|
-
*
|
|
6871
|
+
* Refund amount.
|
|
6872
|
+
* @immutable
|
|
6873
|
+
*/
|
|
6874
|
+
amount?: Price;
|
|
6875
|
+
/** Refund status. */
|
|
6876
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
6877
|
+
/** Optional details of current refund status. */
|
|
6878
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
6879
|
+
/**
|
|
6880
|
+
* Payment gateway's refund ID.
|
|
6881
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
6862
6882
|
* @format GUID
|
|
6863
6883
|
*/
|
|
6864
|
-
|
|
6865
|
-
|
|
6866
|
-
|
|
6867
|
-
interface SiteDeleted {
|
|
6868
|
-
/** A deletion context. */
|
|
6869
|
-
deleteContext?: DeleteContext;
|
|
6870
|
-
}
|
|
6871
|
-
interface DeleteContext {
|
|
6872
|
-
/** When the meta site was deleted. */
|
|
6873
|
-
dateDeleted?: Date | null;
|
|
6874
|
-
/** A status. */
|
|
6875
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
6884
|
+
gatewayRefundId?: string | null;
|
|
6885
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
6886
|
+
providerRefundId?: string | null;
|
|
6876
6887
|
/**
|
|
6877
|
-
*
|
|
6878
|
-
* @
|
|
6888
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
6889
|
+
* @immutable
|
|
6879
6890
|
*/
|
|
6880
|
-
|
|
6891
|
+
externalRefund?: boolean;
|
|
6881
6892
|
/**
|
|
6882
|
-
*
|
|
6883
|
-
* @
|
|
6893
|
+
* Location where the refund was processed.
|
|
6894
|
+
* @internal
|
|
6895
|
+
* @format GUID
|
|
6896
|
+
* @immutable
|
|
6884
6897
|
*/
|
|
6885
|
-
|
|
6898
|
+
locationId?: string | null;
|
|
6886
6899
|
}
|
|
6887
|
-
|
|
6888
|
-
|
|
6889
|
-
|
|
6890
|
-
|
|
6891
|
-
|
|
6892
|
-
|
|
6900
|
+
/** Refund transaction status. */
|
|
6901
|
+
declare enum RefundStatus {
|
|
6902
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
6903
|
+
PENDING = "PENDING",
|
|
6904
|
+
/** Refund transaction succeeded. */
|
|
6905
|
+
SUCCEEDED = "SUCCEEDED",
|
|
6906
|
+
/** Refund transaction failed. */
|
|
6907
|
+
FAILED = "FAILED",
|
|
6908
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
6909
|
+
SCHEDULED = "SCHEDULED",
|
|
6910
|
+
/** Refund was initiated on payment provider side. */
|
|
6911
|
+
STARTED = "STARTED"
|
|
6893
6912
|
}
|
|
6894
6913
|
/** @enumType */
|
|
6895
|
-
type
|
|
6896
|
-
|
|
6897
|
-
interface SiteUndeleted {
|
|
6898
|
-
}
|
|
6899
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
6900
|
-
interface SitePublished {
|
|
6901
|
-
}
|
|
6902
|
-
interface SiteUnpublished {
|
|
6914
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
6915
|
+
interface RefundStatusInfo {
|
|
6903
6916
|
/**
|
|
6904
|
-
*
|
|
6905
|
-
*
|
|
6906
|
-
*
|
|
6917
|
+
* Reason code for the refund's current status.
|
|
6918
|
+
*
|
|
6919
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
6920
|
+
* @minLength 1
|
|
6921
|
+
* @maxLength 10
|
|
6907
6922
|
*/
|
|
6908
|
-
|
|
6909
|
-
|
|
6910
|
-
|
|
6911
|
-
|
|
6912
|
-
|
|
6923
|
+
paymentGatewayReasonCode?: string | null;
|
|
6924
|
+
/**
|
|
6925
|
+
* Free text explanation of current refund status.
|
|
6926
|
+
* @minLength 1
|
|
6927
|
+
* @maxLength 1000
|
|
6928
|
+
*/
|
|
6929
|
+
description?: string | null;
|
|
6913
6930
|
}
|
|
6914
|
-
|
|
6915
|
-
|
|
6916
|
-
|
|
6917
|
-
|
|
6918
|
-
|
|
6919
|
-
|
|
6920
|
-
|
|
6921
|
-
|
|
6922
|
-
|
|
6923
|
-
|
|
6924
|
-
|
|
6925
|
-
|
|
6926
|
-
|
|
6927
|
-
|
|
6928
|
-
|
|
6929
|
-
interface ServiceProvisioned {
|
|
6931
|
+
interface AggregatedRefundSummary {
|
|
6932
|
+
/** Total amount requested for refund. */
|
|
6933
|
+
requestedRefund?: Price;
|
|
6934
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
6935
|
+
pendingRefund?: Price;
|
|
6936
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
6937
|
+
refunded?: Price;
|
|
6938
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6939
|
+
failedRefundAmount?: Price;
|
|
6940
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6941
|
+
pending?: boolean;
|
|
6942
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6943
|
+
breakdown?: RefundItemsBreakdown;
|
|
6944
|
+
}
|
|
6945
|
+
interface RefundItemsBreakdown {
|
|
6930
6946
|
/**
|
|
6931
|
-
*
|
|
6932
|
-
* @
|
|
6947
|
+
* Refunded line items and the amount refunded for each.
|
|
6948
|
+
* @maxSize 300
|
|
6933
6949
|
*/
|
|
6934
|
-
|
|
6950
|
+
lineItems?: LineItemRefundSummary[];
|
|
6951
|
+
}
|
|
6952
|
+
interface LineItemRefundSummary {
|
|
6935
6953
|
/**
|
|
6936
|
-
*
|
|
6937
|
-
* @
|
|
6954
|
+
* ID of the refunded line item.
|
|
6955
|
+
* @format GUID
|
|
6938
6956
|
*/
|
|
6939
|
-
|
|
6957
|
+
lineItemId?: string;
|
|
6958
|
+
/** Total refunded amount for the line item. */
|
|
6959
|
+
totalRefundedAmount?: Price;
|
|
6960
|
+
}
|
|
6961
|
+
interface CalculateRefundRequest {
|
|
6940
6962
|
/**
|
|
6941
|
-
*
|
|
6942
|
-
* @
|
|
6963
|
+
* Order ID
|
|
6964
|
+
* @minLength 1
|
|
6965
|
+
* @maxLength 100
|
|
6943
6966
|
*/
|
|
6944
|
-
|
|
6967
|
+
ecomOrderId?: string;
|
|
6945
6968
|
/**
|
|
6946
|
-
*
|
|
6947
|
-
* @
|
|
6969
|
+
* Refunded line items and quantity
|
|
6970
|
+
* @maxSize 300
|
|
6948
6971
|
*/
|
|
6949
|
-
|
|
6972
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
6973
|
+
/** Should include shipping in refund calculation */
|
|
6974
|
+
refundShipping?: boolean;
|
|
6975
|
+
}
|
|
6976
|
+
interface CalculateRefundItemRequest {
|
|
6950
6977
|
/**
|
|
6951
|
-
*
|
|
6978
|
+
* ID of the line item being refunded
|
|
6952
6979
|
* @format GUID
|
|
6953
6980
|
*/
|
|
6954
|
-
|
|
6955
|
-
}
|
|
6956
|
-
interface ServiceRemoved {
|
|
6981
|
+
id?: string;
|
|
6957
6982
|
/**
|
|
6958
|
-
*
|
|
6959
|
-
* @
|
|
6983
|
+
* How much of that line item is being refunded
|
|
6984
|
+
* @min 1
|
|
6985
|
+
* @max 100000
|
|
6960
6986
|
*/
|
|
6961
|
-
|
|
6987
|
+
quantity?: number;
|
|
6988
|
+
}
|
|
6989
|
+
interface CalculateRefundResponse {
|
|
6990
|
+
/** Total refundable amount */
|
|
6991
|
+
total?: Price;
|
|
6992
|
+
/** Tax cost of the order */
|
|
6993
|
+
tax?: Price;
|
|
6994
|
+
/** Discount given for this order */
|
|
6995
|
+
discount?: Price;
|
|
6996
|
+
/** Total cost of the order (without tax) */
|
|
6997
|
+
subtotal?: Price;
|
|
6998
|
+
/** Total shipping cost for order */
|
|
6999
|
+
shipping?: Price;
|
|
7000
|
+
/** Previous refund given on that order */
|
|
7001
|
+
previouslyRefundedAmount?: Price;
|
|
6962
7002
|
/**
|
|
6963
|
-
*
|
|
6964
|
-
* @
|
|
7003
|
+
* The refundable items of that order
|
|
7004
|
+
* @maxSize 300
|
|
6965
7005
|
*/
|
|
6966
|
-
|
|
7006
|
+
items?: CalculateRefundItemResponse[];
|
|
7007
|
+
}
|
|
7008
|
+
interface CalculateRefundItemResponse {
|
|
6967
7009
|
/**
|
|
6968
|
-
*
|
|
6969
|
-
* @
|
|
7010
|
+
* Line item ID
|
|
7011
|
+
* @format GUID
|
|
6970
7012
|
*/
|
|
6971
|
-
|
|
7013
|
+
id?: string;
|
|
7014
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
7015
|
+
price?: Price;
|
|
6972
7016
|
}
|
|
6973
|
-
|
|
6974
|
-
interface SiteRenamed {
|
|
7017
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
6975
7018
|
/**
|
|
6976
|
-
*
|
|
6977
|
-
* @
|
|
7019
|
+
* Wix eCommerce order ID
|
|
7020
|
+
* @minLength 1
|
|
7021
|
+
* @maxLength 100
|
|
6978
7022
|
*/
|
|
6979
|
-
|
|
7023
|
+
ecomOrderId: string;
|
|
6980
7024
|
/**
|
|
6981
|
-
*
|
|
6982
|
-
* @
|
|
7025
|
+
* Payment IDs
|
|
7026
|
+
* @minSize 1
|
|
7027
|
+
* @maxSize 100
|
|
7028
|
+
* @format GUID
|
|
6983
7029
|
*/
|
|
6984
|
-
|
|
6985
|
-
}
|
|
6986
|
-
/**
|
|
6987
|
-
* Hard deletion of the meta site.
|
|
6988
|
-
*
|
|
6989
|
-
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
6990
|
-
*/
|
|
6991
|
-
interface SiteHardDeleted {
|
|
6992
|
-
/** A deletion context. */
|
|
6993
|
-
deleteContext?: DeleteContext;
|
|
6994
|
-
}
|
|
6995
|
-
interface NamespaceChanged {
|
|
6996
|
-
/** A previous namespace. */
|
|
6997
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
6998
|
-
/** A new namespace. */
|
|
6999
|
-
newNamespace?: NamespaceWithLiterals;
|
|
7000
|
-
}
|
|
7001
|
-
/** Assigned Studio editor */
|
|
7002
|
-
interface StudioAssigned {
|
|
7003
|
-
}
|
|
7004
|
-
/** Unassigned Studio editor */
|
|
7005
|
-
interface StudioUnassigned {
|
|
7030
|
+
paymentIds: string[];
|
|
7006
7031
|
}
|
|
7007
|
-
|
|
7008
|
-
|
|
7009
|
-
|
|
7010
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
7011
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
7012
|
-
*
|
|
7013
|
-
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
7014
|
-
*/
|
|
7015
|
-
interface SiteUrlChanged {
|
|
7032
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
7033
|
+
/** All order's transactions after the void was triggered */
|
|
7034
|
+
orderTransactions?: OrderTransactions;
|
|
7016
7035
|
}
|
|
7017
|
-
|
|
7018
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
7019
|
-
* Consumed by other teams to remove relevant data.
|
|
7020
|
-
*/
|
|
7021
|
-
interface SitePurgedExternally {
|
|
7036
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
7022
7037
|
/**
|
|
7023
|
-
*
|
|
7038
|
+
* Wix eCommerce order ID
|
|
7039
|
+
* @minLength 1
|
|
7040
|
+
* @maxLength 100
|
|
7041
|
+
*/
|
|
7042
|
+
ecomOrderId: string;
|
|
7043
|
+
/**
|
|
7044
|
+
* Capture payments information
|
|
7045
|
+
* @minSize 1
|
|
7024
7046
|
* @maxSize 100
|
|
7025
|
-
* @deprecated
|
|
7026
|
-
* @targetRemovalDate 2025-04-15
|
|
7027
7047
|
*/
|
|
7028
|
-
|
|
7029
|
-
}
|
|
7030
|
-
/** Assigned Odeditor */
|
|
7031
|
-
interface OdeditorAssigned {
|
|
7032
|
-
}
|
|
7033
|
-
/** Unassigned Odeditor */
|
|
7034
|
-
interface OdeditorUnassigned {
|
|
7035
|
-
}
|
|
7036
|
-
/** Assigned Picasso editor */
|
|
7037
|
-
interface PicassoAssigned {
|
|
7038
|
-
}
|
|
7039
|
-
/** Unassigned Picasso */
|
|
7040
|
-
interface PicassoUnassigned {
|
|
7041
|
-
}
|
|
7042
|
-
/** Assigned Wixel */
|
|
7043
|
-
interface WixelAssigned {
|
|
7044
|
-
}
|
|
7045
|
-
/** Unassigned Wixel */
|
|
7046
|
-
interface WixelUnassigned {
|
|
7047
|
-
}
|
|
7048
|
-
/** Assigned StudioTwo */
|
|
7049
|
-
interface StudioTwoAssigned {
|
|
7050
|
-
}
|
|
7051
|
-
/** Unassigned StudioTwo */
|
|
7052
|
-
interface StudioTwoUnassigned {
|
|
7053
|
-
}
|
|
7054
|
-
/** Media from user domain is enabled. */
|
|
7055
|
-
interface UserDomainMediaEnabled {
|
|
7056
|
-
}
|
|
7057
|
-
/** Media from user domain is disabled. */
|
|
7058
|
-
interface UserDomainMediaDisabled {
|
|
7059
|
-
}
|
|
7060
|
-
/** Assigned Editorless */
|
|
7061
|
-
interface EditorlessAssigned {
|
|
7062
|
-
}
|
|
7063
|
-
/** Unassigned Editorless */
|
|
7064
|
-
interface EditorlessUnassigned {
|
|
7048
|
+
payments: PaymentCapture[];
|
|
7065
7049
|
}
|
|
7066
|
-
interface
|
|
7050
|
+
interface PaymentCapture {
|
|
7051
|
+
/**
|
|
7052
|
+
* Payment ID
|
|
7053
|
+
* @format GUID
|
|
7054
|
+
*/
|
|
7055
|
+
paymentId?: string | null;
|
|
7056
|
+
/**
|
|
7057
|
+
* Capture amount.
|
|
7058
|
+
* If not provided - full authorized amount will be captured.
|
|
7059
|
+
*/
|
|
7060
|
+
amount?: Price;
|
|
7067
7061
|
}
|
|
7068
|
-
interface
|
|
7069
|
-
|
|
7062
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
7063
|
+
/** All order's transactions after the capture was triggered */
|
|
7064
|
+
orderTransactions?: OrderTransactions;
|
|
7070
7065
|
}
|
|
7071
|
-
interface
|
|
7072
|
-
/**
|
|
7073
|
-
|
|
7074
|
-
|
|
7075
|
-
|
|
7066
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
7067
|
+
/**
|
|
7068
|
+
* Ecom Order ID.
|
|
7069
|
+
* @minLength 1
|
|
7070
|
+
* @maxLength 100
|
|
7071
|
+
*/
|
|
7072
|
+
ecomOrderId?: string;
|
|
7073
|
+
/** Amount to be charged */
|
|
7074
|
+
amount?: Price;
|
|
7076
7075
|
}
|
|
7077
|
-
|
|
7078
|
-
|
|
7079
|
-
|
|
7076
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
7077
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
7078
|
+
paymentGatewayOrderId?: string;
|
|
7080
7079
|
}
|
|
7081
|
-
|
|
7082
|
-
|
|
7083
|
-
|
|
7084
|
-
|
|
7080
|
+
interface V1TriggerReindexRequest {
|
|
7081
|
+
/** @format GUID */
|
|
7082
|
+
metasiteId?: string;
|
|
7083
|
+
/**
|
|
7084
|
+
* @minLength 1
|
|
7085
|
+
* @maxLength 100
|
|
7086
|
+
* @maxSize 100
|
|
7087
|
+
*/
|
|
7088
|
+
orderIds?: string[];
|
|
7085
7089
|
}
|
|
7086
|
-
interface
|
|
7090
|
+
interface V1TriggerReindexResponse {
|
|
7087
7091
|
}
|
|
7088
|
-
interface
|
|
7089
|
-
|
|
7092
|
+
interface V1TriggerReindexOrderRequest {
|
|
7093
|
+
/** @format GUID */
|
|
7094
|
+
metasiteId?: string;
|
|
7095
|
+
/**
|
|
7096
|
+
* @minLength 1
|
|
7097
|
+
* @maxLength 100
|
|
7098
|
+
*/
|
|
7099
|
+
orderId?: string;
|
|
7090
7100
|
}
|
|
7091
7101
|
interface DiffmatokyPayload {
|
|
7092
7102
|
left?: string;
|