@wix/auto_sdk_ecom_orders 1.0.328 → 1.0.330
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-BmHEmYb8.d.ts → ecom-v1-order-orders.universal-BvamC5-B.d.ts} +1694 -1690
- 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 -1690
- package/build/cjs/meta.js +80 -80
- package/build/cjs/meta.js.map +1 -1
- package/build/es/{ecom-v1-order-orders.universal-BmHEmYb8.d.mts → ecom-v1-order-orders.universal-BvamC5-B.d.mts} +1694 -1690
- 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 -1690
- package/build/es/meta.mjs +80 -80
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/{ecom-v1-order-orders.universal-BAracj8P.d.ts → ecom-v1-order-orders.universal-CQ2URq2O.d.ts} +1813 -1809
- 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 +1813 -1809
- package/build/internal/es/{ecom-v1-order-orders.universal-BAracj8P.d.mts → ecom-v1-order-orders.universal-CQ2URq2O.d.mts} +1813 -1809
- 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 +1813 -1809
- package/package.json +2 -2
|
@@ -3533,6 +3533,8 @@ interface BalanceSummary {
|
|
|
3533
3533
|
paid?: Price;
|
|
3534
3534
|
/**
|
|
3535
3535
|
* Sum of all successfully refunded payments.
|
|
3536
|
+
*
|
|
3537
|
+
* This is an order-level total. For the amount of an individual refund, see `summary.refunded` on each refund returned by [List Transactions For Single Order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-transactions/list-transactions-for-single-order) in the Order Transactions API.
|
|
3536
3538
|
* @readonly
|
|
3537
3539
|
*/
|
|
3538
3540
|
refunded?: Price;
|
|
@@ -4807,2328 +4809,2330 @@ interface BulkDeleteImportedOrdersResponse {
|
|
|
4807
4809
|
*/
|
|
4808
4810
|
jobId?: string;
|
|
4809
4811
|
}
|
|
4810
|
-
interface
|
|
4812
|
+
interface V1TriggerReindexRequest {
|
|
4811
4813
|
/** @format GUID */
|
|
4812
|
-
|
|
4813
|
-
}
|
|
4814
|
-
interface SendBuyerConfirmationEmailResponse {
|
|
4815
|
-
}
|
|
4816
|
-
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
4814
|
+
metasiteId?: string;
|
|
4817
4815
|
/**
|
|
4818
4816
|
* @minLength 1
|
|
4819
4817
|
* @maxLength 100
|
|
4818
|
+
* @maxSize 100
|
|
4820
4819
|
*/
|
|
4821
|
-
|
|
4820
|
+
orderIds?: string[];
|
|
4822
4821
|
}
|
|
4823
|
-
interface
|
|
4822
|
+
interface V1TriggerReindexResponse {
|
|
4824
4823
|
}
|
|
4825
|
-
interface
|
|
4824
|
+
interface V1TriggerReindexOrderRequest {
|
|
4825
|
+
/** @format GUID */
|
|
4826
|
+
metasiteId?: string;
|
|
4826
4827
|
/**
|
|
4827
4828
|
* @minLength 1
|
|
4828
4829
|
* @maxLength 100
|
|
4829
4830
|
*/
|
|
4830
4831
|
orderId?: string;
|
|
4831
4832
|
}
|
|
4832
|
-
interface
|
|
4833
|
-
}
|
|
4834
|
-
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
4835
|
-
/**
|
|
4836
|
-
* IDs of orders to send pickup emails for.
|
|
4837
|
-
* @minSize 1
|
|
4838
|
-
* @maxSize 300
|
|
4839
|
-
*/
|
|
4840
|
-
orderIds?: string[];
|
|
4841
|
-
}
|
|
4842
|
-
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
4843
|
-
}
|
|
4844
|
-
interface SendBuyerShippingConfirmationEmailRequest {
|
|
4833
|
+
interface PreparePaymentCollectionRequest {
|
|
4845
4834
|
/**
|
|
4835
|
+
* Ecom order ID.
|
|
4846
4836
|
* @minLength 1
|
|
4847
4837
|
* @maxLength 100
|
|
4848
4838
|
*/
|
|
4849
|
-
|
|
4850
|
-
|
|
4851
|
-
|
|
4852
|
-
}
|
|
4853
|
-
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
4839
|
+
ecomOrderId: string;
|
|
4840
|
+
/** Amount to collect */
|
|
4841
|
+
amount: Price;
|
|
4854
4842
|
/**
|
|
4855
|
-
*
|
|
4856
|
-
*
|
|
4857
|
-
*
|
|
4843
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
4844
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
4845
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
4858
4846
|
*/
|
|
4859
|
-
|
|
4860
|
-
}
|
|
4861
|
-
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
4862
|
-
}
|
|
4863
|
-
interface SendMerchantOrderReceivedNotificationRequest {
|
|
4847
|
+
paymentGatewayOrderId?: string | null;
|
|
4864
4848
|
/**
|
|
4865
|
-
*
|
|
4866
|
-
*
|
|
4849
|
+
* Whether to delay capture of the payment.
|
|
4850
|
+
* Default: false
|
|
4851
|
+
* @deprecated Whether to delay capture of the payment.
|
|
4852
|
+
* Default: false
|
|
4853
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
4854
|
+
* @targetRemovalDate 2024-09-30
|
|
4867
4855
|
*/
|
|
4868
|
-
|
|
4869
|
-
}
|
|
4870
|
-
interface SendMerchantOrderReceivedNotificationResponse {
|
|
4871
|
-
}
|
|
4872
|
-
interface SendCancelRefundEmailRequest {
|
|
4856
|
+
delayedCapture?: boolean;
|
|
4873
4857
|
/**
|
|
4874
|
-
*
|
|
4875
|
-
*
|
|
4876
|
-
* @
|
|
4858
|
+
* Specifies whether payment collection is initiated by Merchant or User of User
|
|
4859
|
+
* Default: `true`
|
|
4860
|
+
* @internal
|
|
4877
4861
|
*/
|
|
4878
|
-
|
|
4862
|
+
merchantInitiated?: boolean | null;
|
|
4879
4863
|
/**
|
|
4880
|
-
*
|
|
4881
|
-
* @
|
|
4882
|
-
* @maxLength 1000
|
|
4864
|
+
* Redirect urls which are used to return buyer to third party system.
|
|
4865
|
+
* @internal
|
|
4883
4866
|
*/
|
|
4884
|
-
|
|
4885
|
-
/**
|
|
4886
|
-
|
|
4867
|
+
redirectUrls?: RedirectUrls;
|
|
4868
|
+
/** Delayed capture payment settings */
|
|
4869
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
4870
|
+
}
|
|
4871
|
+
interface RedirectUrls {
|
|
4887
4872
|
/**
|
|
4888
|
-
*
|
|
4889
|
-
* @format
|
|
4873
|
+
* URL to redirect buyer in case of approved (successful) transaction
|
|
4874
|
+
* @format WEB_URL
|
|
4890
4875
|
*/
|
|
4891
|
-
|
|
4892
|
-
}
|
|
4893
|
-
interface SendCancelRefundEmailResponse {
|
|
4894
|
-
}
|
|
4895
|
-
interface SendRefundEmailRequest {
|
|
4876
|
+
successUrl?: string | null;
|
|
4896
4877
|
/**
|
|
4897
|
-
*
|
|
4898
|
-
* @format
|
|
4878
|
+
* URL to redirect buyer in case of buyer canceled the transaction
|
|
4879
|
+
* @format WEB_URL
|
|
4899
4880
|
*/
|
|
4900
|
-
|
|
4881
|
+
cancelUrl?: string | null;
|
|
4901
4882
|
/**
|
|
4902
|
-
*
|
|
4903
|
-
* @format
|
|
4883
|
+
* URL to redirect buyer in case of failed/rejected transaction
|
|
4884
|
+
* @format WEB_URL
|
|
4904
4885
|
*/
|
|
4905
|
-
|
|
4886
|
+
errorUrl?: string | null;
|
|
4906
4887
|
/**
|
|
4907
|
-
*
|
|
4908
|
-
* @
|
|
4909
|
-
* @maxLength 1000
|
|
4888
|
+
* URL to redirect buyer in case of pending transaction (that might take some time to process)
|
|
4889
|
+
* @format WEB_URL
|
|
4910
4890
|
*/
|
|
4911
|
-
|
|
4912
|
-
}
|
|
4913
|
-
interface SendRefundEmailResponse {
|
|
4891
|
+
pendingUrl?: string | null;
|
|
4914
4892
|
}
|
|
4915
|
-
interface
|
|
4916
|
-
/**
|
|
4917
|
-
|
|
4918
|
-
/**
|
|
4919
|
-
|
|
4893
|
+
interface DelayedCaptureSettings {
|
|
4894
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
4895
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
4896
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
4897
|
+
delayDuration?: Duration;
|
|
4920
4898
|
}
|
|
4921
|
-
|
|
4899
|
+
declare enum ScheduledAction {
|
|
4900
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
4901
|
+
VOID = "VOID",
|
|
4902
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
4903
|
+
CAPTURE = "CAPTURE"
|
|
4922
4904
|
}
|
|
4923
|
-
|
|
4905
|
+
/** @enumType */
|
|
4906
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
4907
|
+
interface Duration {
|
|
4924
4908
|
/**
|
|
4925
|
-
*
|
|
4926
|
-
* @
|
|
4909
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
4910
|
+
* @min 1
|
|
4927
4911
|
*/
|
|
4928
|
-
|
|
4929
|
-
|
|
4930
|
-
|
|
4931
|
-
}
|
|
4932
|
-
interface PreviewEmailByTypeRequest {
|
|
4933
|
-
emailType?: PreviewEmailTypeWithLiterals;
|
|
4912
|
+
count?: number;
|
|
4913
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
4914
|
+
unit?: DurationUnitWithLiterals;
|
|
4934
4915
|
}
|
|
4935
|
-
declare enum
|
|
4936
|
-
|
|
4937
|
-
|
|
4938
|
-
|
|
4939
|
-
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
4916
|
+
declare enum DurationUnit {
|
|
4917
|
+
MINUTES = "MINUTES",
|
|
4918
|
+
HOURS = "HOURS",
|
|
4919
|
+
DAYS = "DAYS"
|
|
4940
4920
|
}
|
|
4941
4921
|
/** @enumType */
|
|
4942
|
-
type
|
|
4943
|
-
interface
|
|
4944
|
-
|
|
4922
|
+
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
4923
|
+
interface PreparePaymentCollectionResponse {
|
|
4924
|
+
/** Payment gateway order id which is associated with given payment */
|
|
4925
|
+
paymentGatewayOrderId?: string;
|
|
4945
4926
|
}
|
|
4946
|
-
interface
|
|
4927
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
4947
4928
|
/**
|
|
4929
|
+
* Ecom order ID.
|
|
4948
4930
|
* @minLength 1
|
|
4949
4931
|
* @maxLength 100
|
|
4950
4932
|
*/
|
|
4951
|
-
|
|
4952
|
-
/** Refund amount */
|
|
4953
|
-
refundAmount?: Price;
|
|
4954
|
-
/** Refund business details */
|
|
4955
|
-
details?: RefundDetails;
|
|
4956
|
-
/**
|
|
4957
|
-
* Personal note added to the email (optional)
|
|
4958
|
-
* @minLength 1
|
|
4959
|
-
* @maxLength 1000
|
|
4960
|
-
*/
|
|
4961
|
-
customMessage?: string | null;
|
|
4962
|
-
/**
|
|
4963
|
-
* Refund ID. (Optional)
|
|
4964
|
-
* @format GUID
|
|
4965
|
-
*/
|
|
4966
|
-
refundId?: string | null;
|
|
4933
|
+
ecomOrderId: string;
|
|
4967
4934
|
}
|
|
4968
|
-
|
|
4969
|
-
|
|
4935
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
4936
|
+
/** Payment collectability status */
|
|
4937
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
4938
|
+
/** Collectable order amount */
|
|
4939
|
+
amount?: Price;
|
|
4970
4940
|
/**
|
|
4971
|
-
*
|
|
4972
|
-
* @
|
|
4941
|
+
* Whether authorization supported
|
|
4942
|
+
* @internal
|
|
4973
4943
|
*/
|
|
4974
|
-
|
|
4975
|
-
/** Whether the shipping fee was also refunded. */
|
|
4976
|
-
shippingIncluded?: boolean;
|
|
4944
|
+
authorizationSupported?: boolean;
|
|
4977
4945
|
/**
|
|
4978
|
-
*
|
|
4979
|
-
* @
|
|
4946
|
+
* Whether custom amount is supported for payment collection
|
|
4947
|
+
* @internal
|
|
4980
4948
|
*/
|
|
4981
|
-
|
|
4949
|
+
customAmountSupported?: boolean;
|
|
4950
|
+
}
|
|
4951
|
+
declare enum PaymentCollectabilityStatus {
|
|
4952
|
+
UNKNOWN = "UNKNOWN",
|
|
4953
|
+
COLLECTABLE = "COLLECTABLE",
|
|
4954
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
4955
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
4956
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
4957
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
4958
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
4959
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
4960
|
+
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
4961
|
+
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
4962
|
+
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
4963
|
+
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
4964
|
+
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
4965
|
+
}
|
|
4966
|
+
/** @enumType */
|
|
4967
|
+
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';
|
|
4968
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
4982
4969
|
/**
|
|
4983
|
-
*
|
|
4984
|
-
* @
|
|
4970
|
+
* Order ID.
|
|
4971
|
+
* @minLength 1
|
|
4972
|
+
* @maxLength 100
|
|
4985
4973
|
*/
|
|
4986
|
-
|
|
4974
|
+
orderId: string;
|
|
4975
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
4976
|
+
amount: Price;
|
|
4987
4977
|
/**
|
|
4988
|
-
*
|
|
4989
|
-
*
|
|
4978
|
+
* Payment method name provided by user.
|
|
4979
|
+
*
|
|
4980
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4981
|
+
* @internal
|
|
4990
4982
|
*/
|
|
4991
|
-
|
|
4992
|
-
/** Shipping amount that was refunded. */
|
|
4993
|
-
shipping?: ShippingRefund;
|
|
4983
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
4994
4984
|
}
|
|
4995
|
-
|
|
4985
|
+
/**
|
|
4986
|
+
* User-defined payment method name.
|
|
4987
|
+
* Allows specifying either a predefined type or a custom name.
|
|
4988
|
+
*/
|
|
4989
|
+
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
4990
|
+
/** Predefined payment method. */
|
|
4991
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
4996
4992
|
/**
|
|
4997
|
-
*
|
|
4998
|
-
*
|
|
4993
|
+
* Custom payment method name provided by user.
|
|
4994
|
+
*
|
|
4995
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
4996
|
+
* @minLength 1
|
|
4997
|
+
* @maxLength 150
|
|
4999
4998
|
*/
|
|
5000
|
-
|
|
4999
|
+
custom?: string | null;
|
|
5000
|
+
}
|
|
5001
|
+
/** @oneof */
|
|
5002
|
+
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
5003
|
+
/** Predefined payment method. */
|
|
5004
|
+
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5001
5005
|
/**
|
|
5002
|
-
*
|
|
5003
|
-
*
|
|
5004
|
-
*
|
|
5006
|
+
* Custom payment method name provided by user.
|
|
5007
|
+
*
|
|
5008
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5009
|
+
* @minLength 1
|
|
5010
|
+
* @maxLength 150
|
|
5005
5011
|
*/
|
|
5006
|
-
|
|
5012
|
+
custom?: string | null;
|
|
5007
5013
|
}
|
|
5008
|
-
|
|
5014
|
+
/** Predefined payment method types for offline/manual payments. */
|
|
5015
|
+
declare enum PredefinedPaymentMethod {
|
|
5016
|
+
/** Cash payment. */
|
|
5017
|
+
CASH = "CASH",
|
|
5018
|
+
/** Bank transfer. */
|
|
5019
|
+
BANK_TRANSFER = "BANK_TRANSFER",
|
|
5020
|
+
/** Payment by check. */
|
|
5021
|
+
CHECK = "CHECK"
|
|
5022
|
+
}
|
|
5023
|
+
/** @enumType */
|
|
5024
|
+
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
5025
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
5026
|
+
}
|
|
5027
|
+
interface MarkOrderAsPaidRequest {
|
|
5009
5028
|
/**
|
|
5010
|
-
*
|
|
5011
|
-
* @
|
|
5012
|
-
* @
|
|
5029
|
+
* Ecom order ID.
|
|
5030
|
+
* @minLength 1
|
|
5031
|
+
* @maxLength 100
|
|
5013
5032
|
*/
|
|
5014
|
-
|
|
5033
|
+
ecomOrderId: string;
|
|
5015
5034
|
/**
|
|
5016
|
-
*
|
|
5017
|
-
*
|
|
5018
|
-
*
|
|
5019
|
-
* @
|
|
5035
|
+
* Payment method name provided by user.
|
|
5036
|
+
*
|
|
5037
|
+
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5038
|
+
* @internal
|
|
5020
5039
|
*/
|
|
5021
|
-
|
|
5040
|
+
userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
|
|
5022
5041
|
}
|
|
5023
|
-
interface
|
|
5042
|
+
interface MarkOrderAsPaidResponse {
|
|
5043
|
+
/** Updated order. */
|
|
5044
|
+
order?: Order;
|
|
5045
|
+
}
|
|
5046
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
5024
5047
|
/**
|
|
5025
|
-
*
|
|
5026
|
-
* @
|
|
5027
|
-
* @
|
|
5048
|
+
* IDs of orders to mark as paid.
|
|
5049
|
+
* @minSize 1
|
|
5050
|
+
* @maxSize 100
|
|
5051
|
+
* @minLength 1
|
|
5052
|
+
* @maxLength 100
|
|
5028
5053
|
*/
|
|
5029
|
-
|
|
5054
|
+
ecomOrderIds: string[];
|
|
5055
|
+
}
|
|
5056
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
5030
5057
|
/**
|
|
5031
|
-
*
|
|
5032
|
-
*
|
|
5058
|
+
* Items updated by the bulk action.
|
|
5059
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
5033
5060
|
*/
|
|
5034
|
-
|
|
5061
|
+
results?: BulkOrderResult[];
|
|
5062
|
+
/** Bulk action metadata. */
|
|
5063
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
5035
5064
|
}
|
|
5036
|
-
interface
|
|
5065
|
+
interface BulkOrderResult {
|
|
5066
|
+
/** Item metadata. */
|
|
5067
|
+
itemMetadata?: ItemMetadata;
|
|
5037
5068
|
/**
|
|
5038
|
-
*
|
|
5039
|
-
*
|
|
5069
|
+
* Updated order.
|
|
5070
|
+
*
|
|
5071
|
+
* Returned when `returnFullEntity = true`.
|
|
5040
5072
|
*/
|
|
5041
|
-
|
|
5073
|
+
item?: Order;
|
|
5042
5074
|
}
|
|
5043
|
-
interface
|
|
5044
|
-
|
|
5075
|
+
interface ItemMetadata {
|
|
5076
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5077
|
+
_id?: string | null;
|
|
5078
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5079
|
+
originalIndex?: number;
|
|
5080
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5081
|
+
success?: boolean;
|
|
5082
|
+
/** Details about the error in case of failure. */
|
|
5083
|
+
error?: ApplicationError;
|
|
5045
5084
|
}
|
|
5046
|
-
interface
|
|
5085
|
+
interface ApplicationError {
|
|
5086
|
+
/** Error code. */
|
|
5087
|
+
code?: string;
|
|
5088
|
+
/** Description of the error. */
|
|
5089
|
+
description?: string;
|
|
5090
|
+
/** Data related to the error. */
|
|
5091
|
+
data?: Record<string, any> | null;
|
|
5092
|
+
}
|
|
5093
|
+
interface BulkActionMetadata {
|
|
5094
|
+
/** Number of items that were successfully processed. */
|
|
5095
|
+
totalSuccesses?: number;
|
|
5096
|
+
/** Number of items that couldn't be processed. */
|
|
5097
|
+
totalFailures?: number;
|
|
5098
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
5099
|
+
undetailedFailures?: number;
|
|
5100
|
+
}
|
|
5101
|
+
interface GetRefundabilityStatusRequest {
|
|
5047
5102
|
/**
|
|
5103
|
+
* Order ID.
|
|
5048
5104
|
* @minLength 1
|
|
5049
5105
|
* @maxLength 100
|
|
5050
5106
|
*/
|
|
5051
|
-
|
|
5107
|
+
ecomOrderId: string;
|
|
5108
|
+
}
|
|
5109
|
+
interface GetRefundabilityStatusResponse {
|
|
5052
5110
|
/**
|
|
5053
|
-
*
|
|
5054
|
-
* @
|
|
5055
|
-
* @maxLength 1000
|
|
5111
|
+
* Refundability details.
|
|
5112
|
+
* @maxSize 300
|
|
5056
5113
|
*/
|
|
5057
|
-
|
|
5114
|
+
refundabilities?: Refundability[];
|
|
5115
|
+
/**
|
|
5116
|
+
* Whether the order supports refunding per item.
|
|
5117
|
+
* @deprecated
|
|
5118
|
+
*/
|
|
5119
|
+
refundablePerItem?: boolean;
|
|
5058
5120
|
}
|
|
5059
|
-
interface
|
|
5060
|
-
|
|
5121
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5122
|
+
/** Reason why payment is not refundable. */
|
|
5123
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5124
|
+
/** Reason why payment is only refundable manually. */
|
|
5125
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5126
|
+
/** Payment ID. */
|
|
5127
|
+
paymentId?: string;
|
|
5128
|
+
/** Payment refundability status. */
|
|
5129
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
5130
|
+
/** Link to payment provider dashboard. */
|
|
5131
|
+
providerLink?: string | null;
|
|
5061
5132
|
}
|
|
5062
|
-
|
|
5133
|
+
/** @oneof */
|
|
5134
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
5135
|
+
/** Reason why payment is not refundable. */
|
|
5136
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
5137
|
+
/** Reason why payment is only refundable manually. */
|
|
5138
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5139
|
+
}
|
|
5140
|
+
declare enum RefundableStatus {
|
|
5141
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
5142
|
+
MANUAL = "MANUAL",
|
|
5143
|
+
REFUNDABLE = "REFUNDABLE"
|
|
5144
|
+
}
|
|
5145
|
+
/** @enumType */
|
|
5146
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
5147
|
+
declare enum NonRefundableReason {
|
|
5148
|
+
NONE = "NONE",
|
|
5149
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
5150
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
5151
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
5152
|
+
NOT_PAID = "NOT_PAID",
|
|
5153
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
5154
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
5155
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
5156
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
5157
|
+
FORBIDDEN = "FORBIDDEN",
|
|
5158
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
5159
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
5160
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
5161
|
+
}
|
|
5162
|
+
/** @enumType */
|
|
5163
|
+
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';
|
|
5164
|
+
declare enum ManuallyRefundableReason {
|
|
5165
|
+
EXPIRED = "EXPIRED",
|
|
5166
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
5167
|
+
OFFLINE = "OFFLINE",
|
|
5168
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
5169
|
+
}
|
|
5170
|
+
/** @enumType */
|
|
5171
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
5172
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
5063
5173
|
/**
|
|
5174
|
+
* Ecom order ID.
|
|
5064
5175
|
* @minLength 1
|
|
5065
5176
|
* @maxLength 100
|
|
5066
5177
|
*/
|
|
5067
|
-
|
|
5178
|
+
ecomOrderId: string;
|
|
5179
|
+
/** Information about the user who initiated the payment. */
|
|
5180
|
+
chargedBy?: ChargedBy;
|
|
5068
5181
|
/**
|
|
5069
|
-
*
|
|
5070
|
-
*
|
|
5071
|
-
*
|
|
5182
|
+
* Whether to delay capture of the payment.
|
|
5183
|
+
*
|
|
5184
|
+
* Default: false
|
|
5185
|
+
* @internal
|
|
5072
5186
|
*/
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5187
|
+
delayedCapture?: boolean;
|
|
5188
|
+
}
|
|
5189
|
+
interface ChargedBy {
|
|
5076
5190
|
/**
|
|
5077
|
-
*
|
|
5191
|
+
* ID - id of the user who initiated the payment
|
|
5078
5192
|
* @format GUID
|
|
5079
5193
|
*/
|
|
5080
|
-
|
|
5081
|
-
|
|
5082
|
-
|
|
5083
|
-
|
|
5084
|
-
|
|
5085
|
-
|
|
5086
|
-
|
|
5087
|
-
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
5088
|
-
emailPreview?: string;
|
|
5089
|
-
}
|
|
5090
|
-
interface PreviewBuyerConfirmationEmailRequest {
|
|
5194
|
+
_id?: string;
|
|
5195
|
+
/**
|
|
5196
|
+
* Full name - name of the user who initiated the payment
|
|
5197
|
+
* @minLength 1
|
|
5198
|
+
* @maxLength 200
|
|
5199
|
+
*/
|
|
5200
|
+
fullName?: string | null;
|
|
5091
5201
|
}
|
|
5092
|
-
interface
|
|
5093
|
-
|
|
5202
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
5203
|
+
/** ID of the order created in the payment gateway */
|
|
5204
|
+
paymentGatewayOrderId?: string;
|
|
5094
5205
|
}
|
|
5095
|
-
interface
|
|
5206
|
+
interface ChargeMembershipsRequest {
|
|
5207
|
+
/**
|
|
5208
|
+
* Order ID.
|
|
5209
|
+
* @minLength 1
|
|
5210
|
+
* @maxLength 100
|
|
5211
|
+
*/
|
|
5212
|
+
ecomOrderId: string;
|
|
5213
|
+
/**
|
|
5214
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
5215
|
+
* but a user which is using the membership on behalf of the a member
|
|
5216
|
+
* @format GUID
|
|
5217
|
+
*/
|
|
5218
|
+
memberId: string;
|
|
5219
|
+
/**
|
|
5220
|
+
* List of items to be paid by memberships
|
|
5221
|
+
* @minSize 1
|
|
5222
|
+
* @maxSize 300
|
|
5223
|
+
*/
|
|
5224
|
+
membershipCharges?: MembershipChargeItem[];
|
|
5096
5225
|
}
|
|
5097
|
-
interface
|
|
5098
|
-
emailPreview?: string;
|
|
5099
|
-
}
|
|
5100
|
-
interface PreviewShippingConfirmationEmailRequest {
|
|
5101
|
-
}
|
|
5102
|
-
interface PreviewShippingConfirmationEmailResponse {
|
|
5103
|
-
emailPreview?: string;
|
|
5104
|
-
}
|
|
5105
|
-
interface PreviewResendDownloadLinksEmailRequest {
|
|
5106
|
-
}
|
|
5107
|
-
interface PreviewResendDownloadLinksEmailResponse {
|
|
5108
|
-
emailPreview?: string;
|
|
5109
|
-
}
|
|
5110
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
5111
|
-
/** Emitted on a meta site creation. */
|
|
5112
|
-
siteCreated?: SiteCreated;
|
|
5113
|
-
/** Emitted on a meta site transfer completion. */
|
|
5114
|
-
siteTransferred?: SiteTransferred;
|
|
5115
|
-
/** Emitted on a meta site deletion. */
|
|
5116
|
-
siteDeleted?: SiteDeleted;
|
|
5117
|
-
/** Emitted on a meta site restoration. */
|
|
5118
|
-
siteUndeleted?: SiteUndeleted;
|
|
5119
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5120
|
-
sitePublished?: SitePublished;
|
|
5121
|
-
/** Emitted on a meta site unpublish. */
|
|
5122
|
-
siteUnpublished?: SiteUnpublished;
|
|
5123
|
-
/** Emitted when meta site is marked as template. */
|
|
5124
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5125
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5126
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5127
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5128
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5129
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5130
|
-
serviceRemoved?: ServiceRemoved;
|
|
5131
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5132
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5133
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5134
|
-
hardDeleted?: SiteHardDeleted;
|
|
5135
|
-
/** Emitted on a namespace change. */
|
|
5136
|
-
namespaceChanged?: NamespaceChanged;
|
|
5137
|
-
/** Emitted when Studio is attached. */
|
|
5138
|
-
studioAssigned?: StudioAssigned;
|
|
5139
|
-
/** Emitted when Studio is detached. */
|
|
5140
|
-
studioUnassigned?: StudioUnassigned;
|
|
5226
|
+
interface MembershipChargeItem {
|
|
5141
5227
|
/**
|
|
5142
|
-
*
|
|
5143
|
-
*
|
|
5144
|
-
*
|
|
5145
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5146
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5228
|
+
* The id of used membership
|
|
5229
|
+
* @minLength 1
|
|
5230
|
+
* @maxLength 100
|
|
5147
5231
|
*/
|
|
5148
|
-
|
|
5149
|
-
/** Site is marked as PurgedExternally */
|
|
5150
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5151
|
-
/** Emitted when Odeditor is attached. */
|
|
5152
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5153
|
-
/** Emitted when Odeditor is detached. */
|
|
5154
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5155
|
-
/** Emitted when Picasso is attached. */
|
|
5156
|
-
picassoAssigned?: PicassoAssigned;
|
|
5157
|
-
/** Emitted when Picasso is detached. */
|
|
5158
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5159
|
-
/** Emitted when Wixel is attached. */
|
|
5160
|
-
wixelAssigned?: WixelAssigned;
|
|
5161
|
-
/** Emitted when Wixel is detached. */
|
|
5162
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5163
|
-
/** Emitted when StudioTwo is attached. */
|
|
5164
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5165
|
-
/** Emitted when StudioTwo is detached. */
|
|
5166
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5167
|
-
/** Emitted when media from user domain is enabled. */
|
|
5168
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5169
|
-
/** Emitted when media from user domain is disabled. */
|
|
5170
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5171
|
-
/** Emitted when Editorless is attached. */
|
|
5172
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5173
|
-
/** Emitted when Editorless is detached. */
|
|
5174
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5232
|
+
membershipId?: string;
|
|
5175
5233
|
/**
|
|
5176
|
-
*
|
|
5234
|
+
* ID of the application providing this payment option
|
|
5177
5235
|
* @format GUID
|
|
5178
5236
|
*/
|
|
5179
|
-
|
|
5180
|
-
/**
|
|
5181
|
-
|
|
5182
|
-
/**
|
|
5183
|
-
|
|
5184
|
-
/**
|
|
5185
|
-
|
|
5186
|
-
|
|
5187
|
-
|
|
5188
|
-
*/
|
|
5189
|
-
assets?: Asset[];
|
|
5190
|
-
}
|
|
5191
|
-
/** @oneof */
|
|
5192
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
5193
|
-
/** Emitted on a meta site creation. */
|
|
5194
|
-
siteCreated?: SiteCreated;
|
|
5195
|
-
/** Emitted on a meta site transfer completion. */
|
|
5196
|
-
siteTransferred?: SiteTransferred;
|
|
5197
|
-
/** Emitted on a meta site deletion. */
|
|
5198
|
-
siteDeleted?: SiteDeleted;
|
|
5199
|
-
/** Emitted on a meta site restoration. */
|
|
5200
|
-
siteUndeleted?: SiteUndeleted;
|
|
5201
|
-
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
5202
|
-
sitePublished?: SitePublished;
|
|
5203
|
-
/** Emitted on a meta site unpublish. */
|
|
5204
|
-
siteUnpublished?: SiteUnpublished;
|
|
5205
|
-
/** Emitted when meta site is marked as template. */
|
|
5206
|
-
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
5207
|
-
/** Emitted when meta site is marked as a WixSite. */
|
|
5208
|
-
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
5209
|
-
/** Emitted when an application is provisioned (installed). */
|
|
5210
|
-
serviceProvisioned?: ServiceProvisioned;
|
|
5211
|
-
/** Emitted when an application is removed (uninstalled). */
|
|
5212
|
-
serviceRemoved?: ServiceRemoved;
|
|
5213
|
-
/** Emitted when meta site name (URL slug) is changed. */
|
|
5214
|
-
siteRenamedPayload?: SiteRenamed;
|
|
5215
|
-
/** Emitted when meta site was permanently deleted. */
|
|
5216
|
-
hardDeleted?: SiteHardDeleted;
|
|
5217
|
-
/** Emitted on a namespace change. */
|
|
5218
|
-
namespaceChanged?: NamespaceChanged;
|
|
5219
|
-
/** Emitted when Studio is attached. */
|
|
5220
|
-
studioAssigned?: StudioAssigned;
|
|
5221
|
-
/** Emitted when Studio is detached. */
|
|
5222
|
-
studioUnassigned?: StudioUnassigned;
|
|
5223
|
-
/**
|
|
5224
|
-
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
5225
|
-
* the actual URL.
|
|
5226
|
-
*
|
|
5227
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
5228
|
-
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
5229
|
-
*/
|
|
5230
|
-
urlChanged?: SiteUrlChanged;
|
|
5231
|
-
/** Site is marked as PurgedExternally */
|
|
5232
|
-
sitePurgedExternally?: SitePurgedExternally;
|
|
5233
|
-
/** Emitted when Odeditor is attached. */
|
|
5234
|
-
odeditorAssigned?: OdeditorAssigned;
|
|
5235
|
-
/** Emitted when Odeditor is detached. */
|
|
5236
|
-
odeditorUnassigned?: OdeditorUnassigned;
|
|
5237
|
-
/** Emitted when Picasso is attached. */
|
|
5238
|
-
picassoAssigned?: PicassoAssigned;
|
|
5239
|
-
/** Emitted when Picasso is detached. */
|
|
5240
|
-
picassoUnassigned?: PicassoUnassigned;
|
|
5241
|
-
/** Emitted when Wixel is attached. */
|
|
5242
|
-
wixelAssigned?: WixelAssigned;
|
|
5243
|
-
/** Emitted when Wixel is detached. */
|
|
5244
|
-
wixelUnassigned?: WixelUnassigned;
|
|
5245
|
-
/** Emitted when StudioTwo is attached. */
|
|
5246
|
-
studioTwoAssigned?: StudioTwoAssigned;
|
|
5247
|
-
/** Emitted when StudioTwo is detached. */
|
|
5248
|
-
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
5249
|
-
/** Emitted when media from user domain is enabled. */
|
|
5250
|
-
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
5251
|
-
/** Emitted when media from user domain is disabled. */
|
|
5252
|
-
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
5253
|
-
/** Emitted when Editorless is attached. */
|
|
5254
|
-
editorlessAssigned?: EditorlessAssigned;
|
|
5255
|
-
/** Emitted when Editorless is detached. */
|
|
5256
|
-
editorlessUnassigned?: EditorlessUnassigned;
|
|
5257
|
-
}
|
|
5258
|
-
interface Asset {
|
|
5259
|
-
/**
|
|
5260
|
-
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
5261
|
-
* @maxLength 36
|
|
5262
|
-
*/
|
|
5263
|
-
appDefId?: string;
|
|
5264
|
-
/**
|
|
5265
|
-
* An instance id. For legacy reasons may be UUID or a string.
|
|
5266
|
-
* @maxLength 200
|
|
5267
|
-
*/
|
|
5268
|
-
instanceId?: string;
|
|
5269
|
-
/** An application state. */
|
|
5270
|
-
state?: StateWithLiterals;
|
|
5271
|
-
}
|
|
5272
|
-
declare enum State {
|
|
5273
|
-
UNKNOWN = "UNKNOWN",
|
|
5274
|
-
ENABLED = "ENABLED",
|
|
5275
|
-
DISABLED = "DISABLED",
|
|
5276
|
-
PENDING = "PENDING",
|
|
5277
|
-
DEMO = "DEMO"
|
|
5278
|
-
}
|
|
5279
|
-
/** @enumType */
|
|
5280
|
-
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
5281
|
-
interface SiteCreated {
|
|
5237
|
+
appId?: string;
|
|
5238
|
+
/** The name of used membership */
|
|
5239
|
+
membershipName?: MembershipName;
|
|
5240
|
+
/** Additional data about this membership */
|
|
5241
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
5242
|
+
/** Catalog and item reference info. */
|
|
5243
|
+
catalogReference?: CatalogReference;
|
|
5244
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
5245
|
+
serviceProperties?: ServiceProperties;
|
|
5282
5246
|
/**
|
|
5283
|
-
*
|
|
5247
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
5248
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
5249
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
5250
|
+
* @minLength 1
|
|
5284
5251
|
* @maxLength 36
|
|
5285
5252
|
*/
|
|
5286
|
-
|
|
5287
|
-
/**
|
|
5288
|
-
* An account id of the owner.
|
|
5289
|
-
* @format GUID
|
|
5290
|
-
*/
|
|
5291
|
-
ownerId?: string;
|
|
5292
|
-
/** A context in which meta site was created. */
|
|
5293
|
-
context?: SiteCreatedContextWithLiterals;
|
|
5294
|
-
/**
|
|
5295
|
-
* A meta site id from which this site was created.
|
|
5296
|
-
*
|
|
5297
|
-
* In case of a creation from a template it's a template id.
|
|
5298
|
-
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
5299
|
-
* @format GUID
|
|
5300
|
-
*/
|
|
5301
|
-
originMetaSiteId?: string | null;
|
|
5302
|
-
/**
|
|
5303
|
-
* A meta site name (URL slug).
|
|
5304
|
-
* @maxLength 20
|
|
5305
|
-
*/
|
|
5306
|
-
siteName?: string;
|
|
5307
|
-
/** A namespace. */
|
|
5308
|
-
namespace?: NamespaceWithLiterals;
|
|
5309
|
-
}
|
|
5310
|
-
declare enum SiteCreatedContext {
|
|
5311
|
-
/** A valid option, we don't expose all reasons why site might be created. */
|
|
5312
|
-
OTHER = "OTHER",
|
|
5313
|
-
/** A meta site was created from template. */
|
|
5314
|
-
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
5315
|
-
/** A meta site was created by copying of the transfferred meta site. */
|
|
5316
|
-
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
5317
|
-
/** A copy of existing meta site. */
|
|
5318
|
-
DUPLICATE = "DUPLICATE",
|
|
5319
|
-
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
5320
|
-
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
5321
|
-
/** deprecated A meta site was created for Flash editor. */
|
|
5322
|
-
FLASH = "FLASH"
|
|
5323
|
-
}
|
|
5324
|
-
/** @enumType */
|
|
5325
|
-
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
5326
|
-
declare enum Namespace {
|
|
5327
|
-
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
5328
|
-
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
5329
|
-
WIX = "WIX",
|
|
5330
|
-
/** 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. */
|
|
5331
|
-
SHOUT_OUT = "SHOUT_OUT",
|
|
5332
|
-
/** 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. */
|
|
5333
|
-
ALBUMS = "ALBUMS",
|
|
5334
|
-
/** 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. */
|
|
5335
|
-
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
5336
|
-
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5337
|
-
HOTELS = "HOTELS",
|
|
5338
|
-
/** 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. */
|
|
5339
|
-
CLUBS = "CLUBS",
|
|
5340
|
-
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5341
|
-
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
5342
|
-
/**
|
|
5343
|
-
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5344
|
-
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
5345
|
-
*/
|
|
5346
|
-
DEV_SITE = "DEV_SITE",
|
|
5347
|
-
/** 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. */
|
|
5348
|
-
LOGOS = "LOGOS",
|
|
5349
|
-
/** 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. */
|
|
5350
|
-
VIDEO_MAKER = "VIDEO_MAKER",
|
|
5351
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5352
|
-
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
5353
|
-
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5354
|
-
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
5355
|
-
/**
|
|
5356
|
-
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
5357
|
-
*
|
|
5358
|
-
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
5359
|
-
*/
|
|
5360
|
-
HTML_DRAFT = "HTML_DRAFT",
|
|
5361
|
-
/**
|
|
5362
|
-
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
5363
|
-
* Will be accessible from Site List and will not have a website app.
|
|
5364
|
-
* Once the user attaches a site, the site will become a regular wixsite.
|
|
5365
|
-
*/
|
|
5366
|
-
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
5367
|
-
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
5368
|
-
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
5369
|
-
/** It is to be used in the Business First efforts. */
|
|
5370
|
-
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
5371
|
-
/** Bookings business flow with no site. */
|
|
5372
|
-
ANYWHERE = "ANYWHERE",
|
|
5373
|
-
/** Namespace for Headless Backoffice with no editor */
|
|
5374
|
-
HEADLESS = "HEADLESS",
|
|
5253
|
+
rootCatalogItemId?: string | null;
|
|
5375
5254
|
/**
|
|
5376
|
-
*
|
|
5377
|
-
*
|
|
5255
|
+
* line item id of Checkout/Order line item
|
|
5256
|
+
* @minLength 1
|
|
5257
|
+
* @maxLength 100
|
|
5378
5258
|
*/
|
|
5379
|
-
|
|
5380
|
-
|
|
5381
|
-
|
|
5259
|
+
lineItemId?: string;
|
|
5260
|
+
}
|
|
5261
|
+
interface MembershipName {
|
|
5382
5262
|
/**
|
|
5383
|
-
*
|
|
5384
|
-
*
|
|
5385
|
-
* The Mobile company will be the owner of this namespace.
|
|
5263
|
+
* Membership name in the site's original language.
|
|
5264
|
+
* @maxLength 100
|
|
5386
5265
|
*/
|
|
5387
|
-
|
|
5388
|
-
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
5389
|
-
NOWNIA = "NOWNIA",
|
|
5266
|
+
original?: string;
|
|
5390
5267
|
/**
|
|
5391
|
-
*
|
|
5392
|
-
*
|
|
5268
|
+
* Membership name translated into the buyer's language.
|
|
5269
|
+
*
|
|
5270
|
+
* Default: The value of `original`
|
|
5271
|
+
* @maxLength 100
|
|
5393
5272
|
*/
|
|
5394
|
-
|
|
5395
|
-
|
|
5396
|
-
|
|
5397
|
-
|
|
5398
|
-
|
|
5273
|
+
translated?: string | null;
|
|
5274
|
+
}
|
|
5275
|
+
interface ChargeMembershipsResponse {
|
|
5276
|
+
}
|
|
5277
|
+
interface TriggerRefundRequest {
|
|
5399
5278
|
/**
|
|
5400
|
-
*
|
|
5401
|
-
*
|
|
5279
|
+
* The order this refund related to
|
|
5280
|
+
* @minLength 1
|
|
5281
|
+
* @maxLength 100
|
|
5402
5282
|
*/
|
|
5403
|
-
|
|
5404
|
-
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5405
|
-
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
5406
|
-
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
5407
|
-
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
5408
|
-
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
5409
|
-
MIMIR = "MIMIR",
|
|
5410
|
-
/** Wix Twins platform. */
|
|
5411
|
-
TWINS = "TWINS",
|
|
5412
|
-
/** Wix Nano. */
|
|
5413
|
-
NANO = "NANO",
|
|
5414
|
-
/** Base44 headless sites. */
|
|
5415
|
-
BASE44 = "BASE44",
|
|
5416
|
-
/** Wix Channels Sites */
|
|
5417
|
-
CHANNELS = "CHANNELS",
|
|
5418
|
-
/** Nautilus platform. */
|
|
5419
|
-
NAUTILUS = "NAUTILUS",
|
|
5283
|
+
ecomOrderId: string;
|
|
5420
5284
|
/**
|
|
5421
|
-
*
|
|
5422
|
-
*
|
|
5285
|
+
* Refund operations information
|
|
5286
|
+
* @minSize 1
|
|
5287
|
+
* @maxSize 1
|
|
5423
5288
|
*/
|
|
5424
|
-
|
|
5425
|
-
/**
|
|
5426
|
-
|
|
5289
|
+
payments: PaymentRefund[];
|
|
5290
|
+
/** Business model of a refund */
|
|
5291
|
+
details?: RefundDetails;
|
|
5292
|
+
/** Side effect details related to refund */
|
|
5293
|
+
sideEffects?: RefundSideEffects;
|
|
5294
|
+
}
|
|
5295
|
+
interface PaymentRefund {
|
|
5427
5296
|
/**
|
|
5428
|
-
*
|
|
5429
|
-
*
|
|
5297
|
+
* Specific payment within the order to refund
|
|
5298
|
+
* @format GUID
|
|
5430
5299
|
*/
|
|
5431
|
-
|
|
5300
|
+
paymentId?: string;
|
|
5301
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
5302
|
+
amount?: Price;
|
|
5432
5303
|
/**
|
|
5433
|
-
*
|
|
5434
|
-
* (
|
|
5435
|
-
*
|
|
5436
|
-
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
5304
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
5305
|
+
* 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.
|
|
5306
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5437
5307
|
*/
|
|
5438
|
-
|
|
5308
|
+
externalRefund?: boolean;
|
|
5439
5309
|
/**
|
|
5440
|
-
*
|
|
5441
|
-
*
|
|
5310
|
+
* Gateway refund id. When param is present, new refund is not created.
|
|
5311
|
+
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
5312
|
+
* and all side effects from request will be executed.
|
|
5313
|
+
* @internal
|
|
5314
|
+
* @minLength 1
|
|
5315
|
+
* @maxLength 100
|
|
5442
5316
|
*/
|
|
5443
|
-
|
|
5317
|
+
gatewayRefundId?: string | null;
|
|
5444
5318
|
}
|
|
5445
|
-
/**
|
|
5446
|
-
|
|
5447
|
-
/** Site transferred to another user. */
|
|
5448
|
-
interface SiteTransferred {
|
|
5319
|
+
/** Business model of a refund request */
|
|
5320
|
+
interface RefundDetails {
|
|
5449
5321
|
/**
|
|
5450
|
-
*
|
|
5451
|
-
* @
|
|
5322
|
+
* Order line item IDs and quantities that were refunded.
|
|
5323
|
+
* @maxSize 300
|
|
5452
5324
|
*/
|
|
5453
|
-
|
|
5325
|
+
items?: RefundItem[];
|
|
5326
|
+
/** Whether the shipping fee was also refunded. */
|
|
5327
|
+
shippingIncluded?: boolean;
|
|
5454
5328
|
/**
|
|
5455
|
-
*
|
|
5456
|
-
* @
|
|
5329
|
+
* Reason for the refund, provided by customer (optional).
|
|
5330
|
+
* @maxLength 200
|
|
5457
5331
|
*/
|
|
5458
|
-
|
|
5459
|
-
}
|
|
5460
|
-
/** Soft deletion of the meta site. Could be restored. */
|
|
5461
|
-
interface SiteDeleted {
|
|
5462
|
-
/** A deletion context. */
|
|
5463
|
-
deleteContext?: DeleteContext;
|
|
5464
|
-
}
|
|
5465
|
-
interface DeleteContext {
|
|
5466
|
-
/** When the meta site was deleted. */
|
|
5467
|
-
dateDeleted?: Date | null;
|
|
5468
|
-
/** A status. */
|
|
5469
|
-
deleteStatus?: DeleteStatusWithLiterals;
|
|
5332
|
+
reason?: string | null;
|
|
5470
5333
|
/**
|
|
5471
|
-
*
|
|
5472
|
-
* @
|
|
5334
|
+
* Line items that were refunded.
|
|
5335
|
+
* @maxSize 300
|
|
5473
5336
|
*/
|
|
5474
|
-
|
|
5337
|
+
lineItems?: LineItemRefund[];
|
|
5475
5338
|
/**
|
|
5476
|
-
*
|
|
5477
|
-
* @
|
|
5339
|
+
* Additional fees that were refunded.
|
|
5340
|
+
* @maxSize 100
|
|
5478
5341
|
*/
|
|
5479
|
-
|
|
5480
|
-
|
|
5481
|
-
|
|
5482
|
-
UNKNOWN = "UNKNOWN",
|
|
5483
|
-
TRASH = "TRASH",
|
|
5484
|
-
DELETED = "DELETED",
|
|
5485
|
-
PENDING_PURGE = "PENDING_PURGE",
|
|
5486
|
-
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
5487
|
-
}
|
|
5488
|
-
/** @enumType */
|
|
5489
|
-
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
5490
|
-
/** Restoration of the meta site. */
|
|
5491
|
-
interface SiteUndeleted {
|
|
5492
|
-
}
|
|
5493
|
-
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
5494
|
-
interface SitePublished {
|
|
5342
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
5343
|
+
/** Shipping amount that was refunded. */
|
|
5344
|
+
shipping?: ShippingRefund;
|
|
5495
5345
|
}
|
|
5496
|
-
interface
|
|
5346
|
+
interface RefundItem {
|
|
5497
5347
|
/**
|
|
5498
|
-
*
|
|
5499
|
-
* @
|
|
5500
|
-
* @maxSize 10000
|
|
5348
|
+
* Line item ID the refunded line item.
|
|
5349
|
+
* @format GUID
|
|
5501
5350
|
*/
|
|
5502
|
-
|
|
5503
|
-
|
|
5504
|
-
|
|
5505
|
-
|
|
5506
|
-
|
|
5351
|
+
lineItemId?: string;
|
|
5352
|
+
/**
|
|
5353
|
+
* Line item quantity refunded.
|
|
5354
|
+
* @min 1
|
|
5355
|
+
* @max 100000
|
|
5356
|
+
*/
|
|
5357
|
+
quantity?: number;
|
|
5507
5358
|
}
|
|
5508
|
-
|
|
5509
|
-
* Represents a service provisioned a site.
|
|
5510
|
-
*
|
|
5511
|
-
* Note on `origin_instance_id`:
|
|
5512
|
-
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
5513
|
-
* This is because of the following scenario:
|
|
5514
|
-
*
|
|
5515
|
-
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
5516
|
-
* such as a product catalog. When you create a site from this template, you inherit this
|
|
5517
|
-
* default product catalog. However, if the template's product catalog is modified,
|
|
5518
|
-
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
5519
|
-
* your site remains consistent with what you initially received and does not include any
|
|
5520
|
-
* changes made to the original template afterward.
|
|
5521
|
-
* To ensure this, the TPA on the template gets a new instance_id.
|
|
5522
|
-
*/
|
|
5523
|
-
interface ServiceProvisioned {
|
|
5359
|
+
interface LineItemRefund {
|
|
5524
5360
|
/**
|
|
5525
|
-
*
|
|
5526
|
-
* @
|
|
5361
|
+
* Line item ID.
|
|
5362
|
+
* @format GUID
|
|
5363
|
+
* @immutable
|
|
5527
5364
|
*/
|
|
5528
|
-
|
|
5365
|
+
lineItemId?: string;
|
|
5529
5366
|
/**
|
|
5530
|
-
*
|
|
5531
|
-
* @
|
|
5367
|
+
* Refund quantity.
|
|
5368
|
+
* @min 1
|
|
5369
|
+
* @max 100000
|
|
5370
|
+
* @immutable
|
|
5532
5371
|
*/
|
|
5533
|
-
|
|
5372
|
+
quantity?: number;
|
|
5373
|
+
}
|
|
5374
|
+
interface AdditionalFeeRefund {
|
|
5534
5375
|
/**
|
|
5535
|
-
*
|
|
5536
|
-
* @
|
|
5376
|
+
* Additional fee ID.
|
|
5377
|
+
* @format GUID
|
|
5378
|
+
* @immutable
|
|
5537
5379
|
*/
|
|
5538
|
-
|
|
5380
|
+
additionalFeeId?: string;
|
|
5539
5381
|
/**
|
|
5540
|
-
*
|
|
5541
|
-
* @
|
|
5382
|
+
* Refund amount.
|
|
5383
|
+
* @immutable
|
|
5542
5384
|
*/
|
|
5543
|
-
|
|
5385
|
+
amount?: Price;
|
|
5386
|
+
}
|
|
5387
|
+
interface ShippingRefund {
|
|
5544
5388
|
/**
|
|
5545
|
-
*
|
|
5546
|
-
* @
|
|
5389
|
+
* Refund amount.
|
|
5390
|
+
* @immutable
|
|
5547
5391
|
*/
|
|
5548
|
-
|
|
5392
|
+
amount?: Price;
|
|
5549
5393
|
}
|
|
5550
|
-
interface
|
|
5394
|
+
interface RefundSideEffects {
|
|
5395
|
+
/** Inventory restock details as part of this refund. */
|
|
5396
|
+
restockInfo?: RestockInfo;
|
|
5397
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
5398
|
+
sendOrderRefundedEmail?: boolean;
|
|
5551
5399
|
/**
|
|
5552
|
-
*
|
|
5553
|
-
* @
|
|
5400
|
+
* Custom message added to the refund confirmation email.
|
|
5401
|
+
* @minLength 1
|
|
5402
|
+
* @maxLength 1000
|
|
5554
5403
|
*/
|
|
5555
|
-
|
|
5404
|
+
customMessage?: string | null;
|
|
5405
|
+
}
|
|
5406
|
+
interface RestockInfo {
|
|
5407
|
+
/** Restock type. */
|
|
5408
|
+
type?: RestockTypeWithLiterals;
|
|
5556
5409
|
/**
|
|
5557
|
-
*
|
|
5558
|
-
* @
|
|
5410
|
+
* Deprecated, use items instead
|
|
5411
|
+
* @internal
|
|
5412
|
+
* @maxSize 300
|
|
5413
|
+
* @deprecated
|
|
5559
5414
|
*/
|
|
5560
|
-
|
|
5415
|
+
lineItemIds?: string[];
|
|
5561
5416
|
/**
|
|
5562
|
-
*
|
|
5563
|
-
* @
|
|
5417
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
5418
|
+
* @maxSize 300
|
|
5564
5419
|
*/
|
|
5565
|
-
|
|
5420
|
+
items?: RestockItem[];
|
|
5566
5421
|
}
|
|
5567
|
-
|
|
5568
|
-
|
|
5422
|
+
declare enum RestockType {
|
|
5423
|
+
NO_ITEMS = "NO_ITEMS",
|
|
5424
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
5425
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
5426
|
+
}
|
|
5427
|
+
/** @enumType */
|
|
5428
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
5429
|
+
interface RestockItem {
|
|
5569
5430
|
/**
|
|
5570
|
-
*
|
|
5571
|
-
* @
|
|
5431
|
+
* ID of the line item being restocked.
|
|
5432
|
+
* @format GUID
|
|
5572
5433
|
*/
|
|
5573
|
-
|
|
5434
|
+
lineItemId?: string;
|
|
5574
5435
|
/**
|
|
5575
|
-
*
|
|
5576
|
-
* @
|
|
5436
|
+
* Line item quantity being restocked.
|
|
5437
|
+
* @min 1
|
|
5438
|
+
* @max 100000
|
|
5577
5439
|
*/
|
|
5578
|
-
|
|
5579
|
-
|
|
5580
|
-
|
|
5581
|
-
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
interface SiteHardDeleted {
|
|
5586
|
-
/** A deletion context. */
|
|
5587
|
-
deleteContext?: DeleteContext;
|
|
5588
|
-
}
|
|
5589
|
-
interface NamespaceChanged {
|
|
5590
|
-
/** A previous namespace. */
|
|
5591
|
-
oldNamespace?: NamespaceWithLiterals;
|
|
5592
|
-
/** A new namespace. */
|
|
5593
|
-
newNamespace?: NamespaceWithLiterals;
|
|
5594
|
-
}
|
|
5595
|
-
/** Assigned Studio editor */
|
|
5596
|
-
interface StudioAssigned {
|
|
5440
|
+
quantity?: number;
|
|
5441
|
+
/**
|
|
5442
|
+
* Per-location breakdown of restock quantities.
|
|
5443
|
+
* @internal
|
|
5444
|
+
* @maxSize 5
|
|
5445
|
+
*/
|
|
5446
|
+
restockLocations?: RestockLocation[];
|
|
5597
5447
|
}
|
|
5598
|
-
|
|
5599
|
-
|
|
5448
|
+
interface TriggerRefundResponse {
|
|
5449
|
+
/** All order's transactions after the refunds were added */
|
|
5450
|
+
orderTransactions?: OrderTransactions;
|
|
5451
|
+
/** Created refund ID */
|
|
5452
|
+
refundId?: string | null;
|
|
5453
|
+
/** Payment ID's that the refund execution had failed for */
|
|
5454
|
+
failedPaymentIds?: ItemMetadata[];
|
|
5600
5455
|
}
|
|
5601
5456
|
/**
|
|
5602
|
-
*
|
|
5603
|
-
*
|
|
5604
|
-
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
5605
|
-
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
5457
|
+
* A record of all payments and refunds associated with an order.
|
|
5606
5458
|
*
|
|
5607
|
-
*
|
|
5608
|
-
*/
|
|
5609
|
-
interface SiteUrlChanged {
|
|
5610
|
-
}
|
|
5611
|
-
/**
|
|
5612
|
-
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
5613
|
-
* Consumed by other teams to remove relevant data.
|
|
5459
|
+
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
5614
5460
|
*/
|
|
5615
|
-
interface
|
|
5616
|
-
/**
|
|
5617
|
-
* @maxLength 2048
|
|
5618
|
-
* @maxSize 100
|
|
5619
|
-
* @deprecated
|
|
5620
|
-
* @targetRemovalDate 2025-04-15
|
|
5621
|
-
*/
|
|
5622
|
-
appDefId?: string[];
|
|
5623
|
-
}
|
|
5624
|
-
/** Assigned Odeditor */
|
|
5625
|
-
interface OdeditorAssigned {
|
|
5626
|
-
}
|
|
5627
|
-
/** Unassigned Odeditor */
|
|
5628
|
-
interface OdeditorUnassigned {
|
|
5629
|
-
}
|
|
5630
|
-
/** Assigned Picasso editor */
|
|
5631
|
-
interface PicassoAssigned {
|
|
5632
|
-
}
|
|
5633
|
-
/** Unassigned Picasso */
|
|
5634
|
-
interface PicassoUnassigned {
|
|
5635
|
-
}
|
|
5636
|
-
/** Assigned Wixel */
|
|
5637
|
-
interface WixelAssigned {
|
|
5638
|
-
}
|
|
5639
|
-
/** Unassigned Wixel */
|
|
5640
|
-
interface WixelUnassigned {
|
|
5641
|
-
}
|
|
5642
|
-
/** Assigned StudioTwo */
|
|
5643
|
-
interface StudioTwoAssigned {
|
|
5644
|
-
}
|
|
5645
|
-
/** Unassigned StudioTwo */
|
|
5646
|
-
interface StudioTwoUnassigned {
|
|
5647
|
-
}
|
|
5648
|
-
/** Media from user domain is enabled. */
|
|
5649
|
-
interface UserDomainMediaEnabled {
|
|
5650
|
-
}
|
|
5651
|
-
/** Media from user domain is disabled. */
|
|
5652
|
-
interface UserDomainMediaDisabled {
|
|
5653
|
-
}
|
|
5654
|
-
/** Assigned Editorless */
|
|
5655
|
-
interface EditorlessAssigned {
|
|
5656
|
-
}
|
|
5657
|
-
/** Unassigned Editorless */
|
|
5658
|
-
interface EditorlessUnassigned {
|
|
5659
|
-
}
|
|
5660
|
-
interface HasCustomEmailConfigurationsRequest {
|
|
5661
|
-
}
|
|
5662
|
-
interface HasCustomEmailConfigurationsResponse {
|
|
5663
|
-
hasCustomConfigurations?: boolean;
|
|
5664
|
-
}
|
|
5665
|
-
interface AddToAutomationMigrationPopulationRequest {
|
|
5666
|
-
/** When true, sends custom email configurations to automation system via email */
|
|
5667
|
-
sendCustomEmailConfigs?: boolean;
|
|
5668
|
-
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
5669
|
-
origin?: OriginWithLiterals;
|
|
5670
|
-
}
|
|
5671
|
-
declare enum Origin {
|
|
5672
|
-
OPT_IN = "OPT_IN",
|
|
5673
|
-
MIGRATION = "MIGRATION"
|
|
5674
|
-
}
|
|
5675
|
-
/** @enumType */
|
|
5676
|
-
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
5677
|
-
interface AddToAutomationMigrationPopulationResponse {
|
|
5678
|
-
success?: boolean;
|
|
5679
|
-
}
|
|
5680
|
-
interface IsInAutomationMigrationPopulationRequest {
|
|
5681
|
-
}
|
|
5682
|
-
interface IsInAutomationMigrationPopulationResponse {
|
|
5683
|
-
inPopulation?: boolean;
|
|
5684
|
-
}
|
|
5685
|
-
interface PreparePaymentCollectionRequest {
|
|
5461
|
+
interface OrderTransactions {
|
|
5686
5462
|
/**
|
|
5687
|
-
*
|
|
5688
|
-
* @
|
|
5689
|
-
* @maxLength 100
|
|
5463
|
+
* Order ID.
|
|
5464
|
+
* @format GUID
|
|
5690
5465
|
*/
|
|
5691
|
-
|
|
5692
|
-
/** Amount to collect */
|
|
5693
|
-
amount: Price;
|
|
5466
|
+
orderId?: string;
|
|
5694
5467
|
/**
|
|
5695
|
-
*
|
|
5696
|
-
*
|
|
5697
|
-
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
5468
|
+
* Record of payments made to the merchant.
|
|
5469
|
+
* @maxSize 100
|
|
5698
5470
|
*/
|
|
5699
|
-
|
|
5471
|
+
payments?: Payment[];
|
|
5700
5472
|
/**
|
|
5701
|
-
*
|
|
5702
|
-
*
|
|
5703
|
-
* @deprecated Whether to delay capture of the payment.
|
|
5704
|
-
* Default: false
|
|
5705
|
-
* @replacedBy delayed_capture_settings.scheduled_action
|
|
5706
|
-
* @targetRemovalDate 2024-09-30
|
|
5473
|
+
* Record of refunds made to the buyer.
|
|
5474
|
+
* @maxSize 300
|
|
5707
5475
|
*/
|
|
5708
|
-
|
|
5476
|
+
refunds?: Refund[];
|
|
5477
|
+
}
|
|
5478
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
|
|
5479
|
+
/** Regular payment details. */
|
|
5480
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5481
|
+
/** Gift card payment details. */
|
|
5482
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5483
|
+
/** Membership payment details. */
|
|
5484
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5709
5485
|
/**
|
|
5710
|
-
*
|
|
5711
|
-
* Default: `true`
|
|
5486
|
+
* Receipt created by Wix
|
|
5712
5487
|
* @internal
|
|
5713
5488
|
*/
|
|
5714
|
-
|
|
5489
|
+
wixReceipt?: WixReceiptInfo;
|
|
5715
5490
|
/**
|
|
5716
|
-
*
|
|
5491
|
+
* Receipt created by an external system.
|
|
5717
5492
|
* @internal
|
|
5718
5493
|
*/
|
|
5719
|
-
|
|
5720
|
-
/**
|
|
5721
|
-
|
|
5722
|
-
|
|
5723
|
-
|
|
5494
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5495
|
+
/** @internal */
|
|
5496
|
+
canceled?: CanceledStatusDetails;
|
|
5497
|
+
/** @internal */
|
|
5498
|
+
declined?: DeclinedStatusDetails;
|
|
5499
|
+
/** @internal */
|
|
5500
|
+
voided?: VoidedStatusDetails;
|
|
5724
5501
|
/**
|
|
5725
|
-
*
|
|
5726
|
-
* @format
|
|
5502
|
+
* Payment ID.
|
|
5503
|
+
* @format GUID
|
|
5504
|
+
* @readonly
|
|
5727
5505
|
*/
|
|
5728
|
-
|
|
5506
|
+
_id?: string | null;
|
|
5507
|
+
/** 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. */
|
|
5508
|
+
_createdDate?: Date | null;
|
|
5729
5509
|
/**
|
|
5730
|
-
*
|
|
5731
|
-
* @
|
|
5510
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
5511
|
+
* @readonly
|
|
5732
5512
|
*/
|
|
5733
|
-
|
|
5513
|
+
_updatedDate?: Date | null;
|
|
5514
|
+
/** Payment amount. */
|
|
5515
|
+
amount?: Price;
|
|
5734
5516
|
/**
|
|
5735
|
-
*
|
|
5736
|
-
*
|
|
5517
|
+
* Whether refunds for this payment are disabled.
|
|
5518
|
+
* + `true`: This payment is not refundable.
|
|
5519
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
5737
5520
|
*/
|
|
5738
|
-
|
|
5521
|
+
refundDisabled?: boolean;
|
|
5739
5522
|
/**
|
|
5740
|
-
*
|
|
5741
|
-
*
|
|
5523
|
+
* Whether receipt generation is allowed for this payment.
|
|
5524
|
+
* + `true`: This payment supports receipt generation.
|
|
5525
|
+
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
5526
|
+
* @readonly
|
|
5742
5527
|
*/
|
|
5743
|
-
|
|
5744
|
-
|
|
5745
|
-
|
|
5746
|
-
/**
|
|
5747
|
-
|
|
5748
|
-
|
|
5749
|
-
|
|
5750
|
-
|
|
5751
|
-
|
|
5752
|
-
/** Whether payment will be auto-voided when duration passes */
|
|
5753
|
-
VOID = "VOID",
|
|
5754
|
-
/** Whether payment will be auto-captured when duration passes */
|
|
5755
|
-
CAPTURE = "CAPTURE"
|
|
5756
|
-
}
|
|
5757
|
-
/** @enumType */
|
|
5758
|
-
type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
|
|
5759
|
-
interface Duration {
|
|
5528
|
+
supportReceiptGeneration?: boolean;
|
|
5529
|
+
/** Details about cash rounding applied to this payment, when relevant. */
|
|
5530
|
+
cashRounding?: CashRoundingDetails;
|
|
5531
|
+
/**
|
|
5532
|
+
* Overall payment status.
|
|
5533
|
+
*
|
|
5534
|
+
* Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
|
|
5535
|
+
*/
|
|
5536
|
+
status?: PaymentStatusWithLiterals;
|
|
5760
5537
|
/**
|
|
5761
|
-
*
|
|
5762
|
-
* @
|
|
5538
|
+
* Detailed payment status information including gateway reason codes and status-specific details.
|
|
5539
|
+
* @internal
|
|
5763
5540
|
*/
|
|
5764
|
-
|
|
5765
|
-
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
5766
|
-
unit?: DurationUnitWithLiterals;
|
|
5767
|
-
}
|
|
5768
|
-
declare enum DurationUnit {
|
|
5769
|
-
MINUTES = "MINUTES",
|
|
5770
|
-
HOURS = "HOURS",
|
|
5771
|
-
DAYS = "DAYS"
|
|
5772
|
-
}
|
|
5773
|
-
/** @enumType */
|
|
5774
|
-
type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
5775
|
-
interface PreparePaymentCollectionResponse {
|
|
5776
|
-
/** Payment gateway order id which is associated with given payment */
|
|
5777
|
-
paymentGatewayOrderId?: string;
|
|
5778
|
-
}
|
|
5779
|
-
interface GetPaymentCollectabilityStatusRequest {
|
|
5541
|
+
paymentStatusDetails?: PaymentStatusDetails;
|
|
5780
5542
|
/**
|
|
5781
|
-
*
|
|
5782
|
-
* @
|
|
5783
|
-
* @
|
|
5543
|
+
* Location where the payment was processed.
|
|
5544
|
+
* @internal
|
|
5545
|
+
* @format GUID
|
|
5546
|
+
* @immutable
|
|
5784
5547
|
*/
|
|
5785
|
-
|
|
5548
|
+
locationId?: string | null;
|
|
5549
|
+
/**
|
|
5550
|
+
* ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
|
|
5551
|
+
* @format GUID
|
|
5552
|
+
*/
|
|
5553
|
+
chargeCorrelationId?: string | null;
|
|
5786
5554
|
}
|
|
5787
|
-
|
|
5788
|
-
|
|
5789
|
-
|
|
5790
|
-
|
|
5791
|
-
|
|
5555
|
+
/** @oneof */
|
|
5556
|
+
interface PaymentPaymentDetailsOneOf {
|
|
5557
|
+
/** Regular payment details. */
|
|
5558
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
5559
|
+
/** Gift card payment details. */
|
|
5560
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
5561
|
+
/** Membership payment details. */
|
|
5562
|
+
membershipPaymentDetails?: MembershipPaymentDetails;
|
|
5563
|
+
}
|
|
5564
|
+
/** @oneof */
|
|
5565
|
+
interface PaymentReceiptInfoOneOf {
|
|
5792
5566
|
/**
|
|
5793
|
-
*
|
|
5567
|
+
* Receipt created by Wix
|
|
5794
5568
|
* @internal
|
|
5795
5569
|
*/
|
|
5796
|
-
|
|
5570
|
+
wixReceipt?: WixReceiptInfo;
|
|
5797
5571
|
/**
|
|
5798
|
-
*
|
|
5572
|
+
* Receipt created by an external system.
|
|
5799
5573
|
* @internal
|
|
5800
5574
|
*/
|
|
5801
|
-
|
|
5575
|
+
externalReceipt?: ExternalReceiptInfo;
|
|
5802
5576
|
}
|
|
5803
|
-
|
|
5804
|
-
|
|
5805
|
-
|
|
5806
|
-
|
|
5807
|
-
|
|
5808
|
-
|
|
5809
|
-
|
|
5810
|
-
|
|
5811
|
-
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
|
|
5812
|
-
NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
|
|
5813
|
-
NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
|
|
5814
|
-
NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
|
|
5815
|
-
NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
|
|
5816
|
-
NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
|
|
5577
|
+
/** @oneof */
|
|
5578
|
+
interface PaymentStatusDetailsOneOf {
|
|
5579
|
+
/** @internal */
|
|
5580
|
+
canceled?: CanceledStatusDetails;
|
|
5581
|
+
/** @internal */
|
|
5582
|
+
declined?: DeclinedStatusDetails;
|
|
5583
|
+
/** @internal */
|
|
5584
|
+
voided?: VoidedStatusDetails;
|
|
5817
5585
|
}
|
|
5818
|
-
|
|
5819
|
-
|
|
5820
|
-
|
|
5586
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5587
|
+
/** Credit card details. */
|
|
5588
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5821
5589
|
/**
|
|
5822
|
-
*
|
|
5823
|
-
* @minLength 1
|
|
5590
|
+
* Wix Payments order ID.
|
|
5824
5591
|
* @maxLength 100
|
|
5825
5592
|
*/
|
|
5826
|
-
|
|
5827
|
-
/** Amount to be recorded as approved manual payment for given order */
|
|
5828
|
-
amount: Price;
|
|
5593
|
+
paymentOrderId?: string | null;
|
|
5829
5594
|
/**
|
|
5830
|
-
* Payment
|
|
5831
|
-
*
|
|
5832
|
-
*
|
|
5833
|
-
* @internal
|
|
5595
|
+
* Payment gateway's transaction ID.
|
|
5596
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
5597
|
+
* @maxLength 100
|
|
5834
5598
|
*/
|
|
5835
|
-
|
|
5836
|
-
}
|
|
5837
|
-
/**
|
|
5838
|
-
* User-defined payment method name.
|
|
5839
|
-
* Allows specifying either a predefined type or a custom name.
|
|
5840
|
-
*/
|
|
5841
|
-
interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
|
|
5842
|
-
/** Predefined payment method. */
|
|
5843
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5599
|
+
gatewayTransactionId?: string | null;
|
|
5844
5600
|
/**
|
|
5845
|
-
*
|
|
5846
|
-
*
|
|
5847
|
-
*
|
|
5848
|
-
*
|
|
5601
|
+
* Payment method.
|
|
5602
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5603
|
+
* Non-exhaustive list of supported values:
|
|
5604
|
+
* + `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`
|
|
5849
5605
|
* @maxLength 150
|
|
5606
|
+
* @deprecated Payment method.
|
|
5607
|
+
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
5608
|
+
* Non-exhaustive list of supported values:
|
|
5609
|
+
* + `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`
|
|
5610
|
+
* @replacedBy payment_method_name
|
|
5611
|
+
* @targetRemovalDate 2026-07-01
|
|
5850
5612
|
*/
|
|
5851
|
-
|
|
5852
|
-
}
|
|
5853
|
-
/** @oneof */
|
|
5854
|
-
interface UserDefinedPaymentMethodNameKindOneOf {
|
|
5855
|
-
/** Predefined payment method. */
|
|
5856
|
-
predefined?: PredefinedPaymentMethodWithLiterals;
|
|
5613
|
+
paymentMethod?: string | null;
|
|
5857
5614
|
/**
|
|
5858
|
-
*
|
|
5859
|
-
*
|
|
5860
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5861
|
-
* @minLength 1
|
|
5862
|
-
* @maxLength 150
|
|
5615
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
5616
|
+
* @maxLength 100
|
|
5863
5617
|
*/
|
|
5864
|
-
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
declare enum PredefinedPaymentMethod {
|
|
5868
|
-
/** Cash payment. */
|
|
5869
|
-
CASH = "CASH",
|
|
5870
|
-
/** Bank transfer. */
|
|
5871
|
-
BANK_TRANSFER = "BANK_TRANSFER",
|
|
5872
|
-
/** Payment by check. */
|
|
5873
|
-
CHECK = "CHECK"
|
|
5874
|
-
}
|
|
5875
|
-
/** @enumType */
|
|
5876
|
-
type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
|
|
5877
|
-
interface RecordManuallyCollectedPaymentResponse {
|
|
5878
|
-
}
|
|
5879
|
-
interface MarkOrderAsPaidRequest {
|
|
5618
|
+
providerTransactionId?: string | null;
|
|
5619
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
5620
|
+
offlinePayment?: boolean;
|
|
5880
5621
|
/**
|
|
5881
|
-
*
|
|
5882
|
-
* @
|
|
5883
|
-
* @
|
|
5622
|
+
* Payment status.
|
|
5623
|
+
* @deprecated Payment status.
|
|
5624
|
+
* @replacedBy payment.status
|
|
5625
|
+
* @targetRemovalDate 2026-11-01
|
|
5884
5626
|
*/
|
|
5885
|
-
|
|
5627
|
+
status?: TransactionStatusWithLiterals;
|
|
5628
|
+
/** Whether there is a payment agreement that allows for future charges. */
|
|
5629
|
+
savedPaymentMethod?: boolean;
|
|
5630
|
+
/** Authorization details. */
|
|
5631
|
+
authorizationDetails?: AuthorizationDetails;
|
|
5886
5632
|
/**
|
|
5887
|
-
* Payment
|
|
5888
|
-
*
|
|
5889
|
-
* For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
|
|
5633
|
+
* Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
|
|
5890
5634
|
* @internal
|
|
5635
|
+
* @maxLength 300
|
|
5891
5636
|
*/
|
|
5892
|
-
|
|
5893
|
-
}
|
|
5894
|
-
interface MarkOrderAsPaidResponse {
|
|
5895
|
-
/** Updated order. */
|
|
5896
|
-
order?: Order;
|
|
5897
|
-
}
|
|
5898
|
-
interface BulkMarkOrdersAsPaidRequest {
|
|
5637
|
+
paymentProvider?: string | null;
|
|
5899
5638
|
/**
|
|
5900
|
-
*
|
|
5901
|
-
* @
|
|
5902
|
-
* @maxSize 100
|
|
5903
|
-
* @minLength 1
|
|
5904
|
-
* @maxLength 100
|
|
5639
|
+
* Record of chargebacks made by the buyer.
|
|
5640
|
+
* @maxSize 6
|
|
5905
5641
|
*/
|
|
5906
|
-
|
|
5907
|
-
}
|
|
5908
|
-
interface BulkMarkOrdersAsPaidResponse {
|
|
5642
|
+
chargebacks?: Chargeback[];
|
|
5909
5643
|
/**
|
|
5910
|
-
*
|
|
5911
|
-
*
|
|
5644
|
+
* Payment method ID.
|
|
5645
|
+
* @internal
|
|
5646
|
+
* @maxLength 36
|
|
5912
5647
|
*/
|
|
5913
|
-
|
|
5914
|
-
/**
|
|
5915
|
-
|
|
5916
|
-
}
|
|
5917
|
-
interface BulkOrderResult {
|
|
5918
|
-
/** Item metadata. */
|
|
5919
|
-
itemMetadata?: ItemMetadata;
|
|
5648
|
+
paymentMethodId?: string | null;
|
|
5649
|
+
/** Platform fee amount associated with this payment. */
|
|
5650
|
+
platformFee?: Price;
|
|
5920
5651
|
/**
|
|
5921
|
-
*
|
|
5922
|
-
*
|
|
5923
|
-
*
|
|
5652
|
+
* Payment method with buyer and optional owner translations.
|
|
5653
|
+
* Non-exhaustive list of supported values:
|
|
5654
|
+
* + `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`
|
|
5924
5655
|
*/
|
|
5925
|
-
|
|
5926
|
-
}
|
|
5927
|
-
interface ItemMetadata {
|
|
5928
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
5929
|
-
_id?: string | null;
|
|
5930
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
5931
|
-
originalIndex?: number;
|
|
5932
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
5933
|
-
success?: boolean;
|
|
5934
|
-
/** Details about the error in case of failure. */
|
|
5935
|
-
error?: ApplicationError;
|
|
5656
|
+
paymentMethodName?: PaymentMethodName;
|
|
5936
5657
|
}
|
|
5937
|
-
|
|
5938
|
-
|
|
5939
|
-
|
|
5940
|
-
|
|
5941
|
-
description?: string;
|
|
5942
|
-
/** Data related to the error. */
|
|
5943
|
-
data?: Record<string, any> | null;
|
|
5658
|
+
/** @oneof */
|
|
5659
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
5660
|
+
/** Credit card details. */
|
|
5661
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
5944
5662
|
}
|
|
5945
|
-
|
|
5946
|
-
|
|
5947
|
-
|
|
5948
|
-
|
|
5949
|
-
|
|
5950
|
-
|
|
5951
|
-
|
|
5663
|
+
declare enum TransactionStatus {
|
|
5664
|
+
UNDEFINED = "UNDEFINED",
|
|
5665
|
+
APPROVED = "APPROVED",
|
|
5666
|
+
PENDING = "PENDING",
|
|
5667
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
5668
|
+
CANCELED = "CANCELED",
|
|
5669
|
+
DECLINED = "DECLINED",
|
|
5670
|
+
REFUNDED = "REFUNDED",
|
|
5671
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
5672
|
+
AUTHORIZED = "AUTHORIZED",
|
|
5673
|
+
VOIDED = "VOIDED"
|
|
5952
5674
|
}
|
|
5953
|
-
|
|
5675
|
+
/** @enumType */
|
|
5676
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
5677
|
+
interface CreditCardPaymentMethodDetails {
|
|
5954
5678
|
/**
|
|
5955
|
-
*
|
|
5956
|
-
* @
|
|
5679
|
+
* The last 4 digits of the card number.
|
|
5680
|
+
* @maxLength 4
|
|
5681
|
+
*/
|
|
5682
|
+
lastFourDigits?: string | null;
|
|
5683
|
+
/**
|
|
5684
|
+
* Card issuer's brand.
|
|
5957
5685
|
* @maxLength 100
|
|
5958
5686
|
*/
|
|
5959
|
-
|
|
5687
|
+
brand?: string | null;
|
|
5960
5688
|
}
|
|
5961
|
-
interface
|
|
5689
|
+
interface AuthorizationDetails {
|
|
5962
5690
|
/**
|
|
5963
|
-
*
|
|
5964
|
-
* @
|
|
5691
|
+
* Whether the authorized payment is of a delayed capture.
|
|
5692
|
+
* @readonly
|
|
5965
5693
|
*/
|
|
5966
|
-
|
|
5694
|
+
delayedCapture?: boolean;
|
|
5695
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5696
|
+
authorizedDate?: Date | null;
|
|
5967
5697
|
/**
|
|
5968
|
-
*
|
|
5969
|
-
*
|
|
5698
|
+
* List of captures associated with payment
|
|
5699
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
5700
|
+
* @maxSize 1
|
|
5970
5701
|
*/
|
|
5971
|
-
|
|
5972
|
-
|
|
5973
|
-
|
|
5974
|
-
/**
|
|
5975
|
-
|
|
5976
|
-
/** Reason why payment is only refundable manually. */
|
|
5977
|
-
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
5978
|
-
/** Payment ID. */
|
|
5979
|
-
paymentId?: string;
|
|
5980
|
-
/** Payment refundability status. */
|
|
5981
|
-
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
5982
|
-
/** Link to payment provider dashboard. */
|
|
5983
|
-
providerLink?: string | null;
|
|
5702
|
+
captures?: AuthorizationCapture[];
|
|
5703
|
+
/** Void associated with payment */
|
|
5704
|
+
void?: AuthorizationVoid;
|
|
5705
|
+
/** Scheduled action for this transaction */
|
|
5706
|
+
scheduledAction?: V1ScheduledAction;
|
|
5984
5707
|
}
|
|
5985
|
-
|
|
5986
|
-
|
|
5987
|
-
|
|
5988
|
-
|
|
5989
|
-
|
|
5990
|
-
|
|
5708
|
+
interface AuthorizationCapture {
|
|
5709
|
+
/**
|
|
5710
|
+
* Capture ID.
|
|
5711
|
+
* @format GUID
|
|
5712
|
+
* @readonly
|
|
5713
|
+
*/
|
|
5714
|
+
_id?: string | null;
|
|
5715
|
+
/** Status of this capture action */
|
|
5716
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
5717
|
+
/**
|
|
5718
|
+
* Amount of this capture
|
|
5719
|
+
* @immutable
|
|
5720
|
+
*/
|
|
5721
|
+
amount?: Price;
|
|
5722
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5723
|
+
_createdDate?: Date | null;
|
|
5724
|
+
/** In case of status is FAILED may contain failure details */
|
|
5725
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5991
5726
|
}
|
|
5992
|
-
declare enum
|
|
5993
|
-
|
|
5994
|
-
|
|
5995
|
-
|
|
5727
|
+
declare enum AuthorizationCaptureStatus {
|
|
5728
|
+
/** Capture operation still in progress. */
|
|
5729
|
+
PENDING = "PENDING",
|
|
5730
|
+
/** Capture operation succeeded. */
|
|
5731
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5732
|
+
/** Capture operation failed. */
|
|
5733
|
+
FAILED = "FAILED"
|
|
5996
5734
|
}
|
|
5997
5735
|
/** @enumType */
|
|
5998
|
-
type
|
|
5999
|
-
|
|
6000
|
-
|
|
6001
|
-
|
|
6002
|
-
|
|
6003
|
-
|
|
6004
|
-
|
|
6005
|
-
|
|
6006
|
-
|
|
6007
|
-
|
|
6008
|
-
|
|
6009
|
-
|
|
6010
|
-
|
|
6011
|
-
|
|
6012
|
-
|
|
5736
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5737
|
+
interface AuthorizationActionFailureDetails {
|
|
5738
|
+
/** @maxLength 100 */
|
|
5739
|
+
failureCode?: string;
|
|
5740
|
+
}
|
|
5741
|
+
interface AuthorizationVoid {
|
|
5742
|
+
/** Status of this void action */
|
|
5743
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
5744
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
5745
|
+
voidedDate?: Date | null;
|
|
5746
|
+
/** In case of status is FAILED may contain failure details */
|
|
5747
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
5748
|
+
/** Reason of void action */
|
|
5749
|
+
reason?: ReasonWithLiterals;
|
|
5750
|
+
}
|
|
5751
|
+
declare enum AuthorizationVoidStatus {
|
|
5752
|
+
/** Void operation still in progress. */
|
|
5753
|
+
PENDING = "PENDING",
|
|
5754
|
+
/** Void operation succeeded. */
|
|
5755
|
+
SUCCEEDED = "SUCCEEDED",
|
|
5756
|
+
/** Void operation failed. */
|
|
5757
|
+
FAILED = "FAILED"
|
|
6013
5758
|
}
|
|
6014
5759
|
/** @enumType */
|
|
6015
|
-
type
|
|
6016
|
-
|
|
6017
|
-
|
|
6018
|
-
|
|
6019
|
-
|
|
6020
|
-
|
|
5760
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
5761
|
+
/** Reason the authorization was voided. */
|
|
5762
|
+
declare enum Reason {
|
|
5763
|
+
/** Authorization was voided by user. */
|
|
5764
|
+
MANUAL = "MANUAL",
|
|
5765
|
+
/** Authorization passed execution date. */
|
|
5766
|
+
SCHEDULED = "SCHEDULED"
|
|
6021
5767
|
}
|
|
6022
5768
|
/** @enumType */
|
|
6023
|
-
type
|
|
6024
|
-
interface
|
|
6025
|
-
/**
|
|
6026
|
-
|
|
6027
|
-
|
|
6028
|
-
|
|
6029
|
-
*/
|
|
6030
|
-
ecomOrderId: string;
|
|
6031
|
-
/** Information about the user who initiated the payment. */
|
|
6032
|
-
chargedBy?: ChargedBy;
|
|
6033
|
-
/**
|
|
6034
|
-
* Whether to delay capture of the payment.
|
|
6035
|
-
*
|
|
6036
|
-
* Default: false
|
|
6037
|
-
* @internal
|
|
6038
|
-
*/
|
|
6039
|
-
delayedCapture?: boolean;
|
|
5769
|
+
type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
|
|
5770
|
+
interface V1ScheduledAction {
|
|
5771
|
+
/** Type of the action. */
|
|
5772
|
+
actionType?: ActionTypeWithLiterals;
|
|
5773
|
+
/** The date and time of the action. */
|
|
5774
|
+
executionDate?: Date | null;
|
|
6040
5775
|
}
|
|
6041
|
-
|
|
5776
|
+
declare enum ActionType {
|
|
5777
|
+
VOID = "VOID",
|
|
5778
|
+
CAPTURE = "CAPTURE"
|
|
5779
|
+
}
|
|
5780
|
+
/** @enumType */
|
|
5781
|
+
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
5782
|
+
interface Chargeback {
|
|
6042
5783
|
/**
|
|
6043
|
-
* ID
|
|
5784
|
+
* Chargeback ID.
|
|
6044
5785
|
* @format GUID
|
|
5786
|
+
* @readonly
|
|
5787
|
+
* @immutable
|
|
6045
5788
|
*/
|
|
6046
5789
|
_id?: string;
|
|
6047
5790
|
/**
|
|
6048
|
-
*
|
|
6049
|
-
* @
|
|
6050
|
-
* @
|
|
5791
|
+
* 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.
|
|
5792
|
+
* @readonly
|
|
5793
|
+
* @immutable
|
|
6051
5794
|
*/
|
|
6052
|
-
|
|
6053
|
-
}
|
|
6054
|
-
interface CreatePaymentGatewayOrderResponse {
|
|
6055
|
-
/** ID of the order created in the payment gateway */
|
|
6056
|
-
paymentGatewayOrderId?: string;
|
|
6057
|
-
}
|
|
6058
|
-
interface ChargeMembershipsRequest {
|
|
5795
|
+
_createdDate?: Date | null;
|
|
6059
5796
|
/**
|
|
6060
|
-
*
|
|
6061
|
-
* @
|
|
6062
|
-
* @maxLength 100
|
|
5797
|
+
* 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.
|
|
5798
|
+
* @readonly
|
|
6063
5799
|
*/
|
|
6064
|
-
|
|
5800
|
+
_updatedDate?: Date | null;
|
|
6065
5801
|
/**
|
|
6066
|
-
*
|
|
6067
|
-
*
|
|
6068
|
-
* @
|
|
5802
|
+
* Amount.
|
|
5803
|
+
* @readonly
|
|
5804
|
+
* @immutable
|
|
6069
5805
|
*/
|
|
6070
|
-
|
|
5806
|
+
amount?: Price;
|
|
6071
5807
|
/**
|
|
6072
|
-
*
|
|
6073
|
-
* @
|
|
6074
|
-
* @maxSize 300
|
|
5808
|
+
* Reversal amount. Present only when status is REVERSED.
|
|
5809
|
+
* @readonly
|
|
6075
5810
|
*/
|
|
6076
|
-
|
|
6077
|
-
}
|
|
6078
|
-
interface MembershipChargeItem {
|
|
5811
|
+
reversalAmount?: Price;
|
|
6079
5812
|
/**
|
|
6080
|
-
*
|
|
6081
|
-
*
|
|
6082
|
-
*
|
|
5813
|
+
* Status.
|
|
5814
|
+
*
|
|
5815
|
+
* Default: `"APPROVED"`.
|
|
6083
5816
|
*/
|
|
6084
|
-
|
|
5817
|
+
status?: ChargebackStatusWithLiterals;
|
|
6085
5818
|
/**
|
|
6086
|
-
*
|
|
5819
|
+
* External chargeback ID.
|
|
6087
5820
|
* @format GUID
|
|
5821
|
+
* @readonly
|
|
5822
|
+
* @immutable
|
|
6088
5823
|
*/
|
|
6089
|
-
|
|
6090
|
-
|
|
6091
|
-
|
|
6092
|
-
/**
|
|
6093
|
-
|
|
6094
|
-
/**
|
|
6095
|
-
|
|
6096
|
-
|
|
6097
|
-
|
|
5824
|
+
externalId?: string | null;
|
|
5825
|
+
}
|
|
5826
|
+
declare enum ChargebackStatus {
|
|
5827
|
+
/** Chargeback was approved. */
|
|
5828
|
+
APPROVED = "APPROVED",
|
|
5829
|
+
/** Chargeback was reversed. */
|
|
5830
|
+
REVERSED = "REVERSED"
|
|
5831
|
+
}
|
|
5832
|
+
/** @enumType */
|
|
5833
|
+
type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
|
|
5834
|
+
interface PaymentMethodName {
|
|
6098
5835
|
/**
|
|
6099
|
-
*
|
|
6100
|
-
*
|
|
6101
|
-
|
|
6102
|
-
|
|
6103
|
-
|
|
5836
|
+
* Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
|
|
5837
|
+
* @maxLength 150
|
|
5838
|
+
*/
|
|
5839
|
+
buyerLanguageName?: string | null;
|
|
5840
|
+
/**
|
|
5841
|
+
* Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
|
|
5842
|
+
*
|
|
5843
|
+
* When no site-language name is stored, holds the same value as `buyerLanguageName`.
|
|
5844
|
+
* @maxLength 150
|
|
6104
5845
|
*/
|
|
6105
|
-
|
|
5846
|
+
siteLanguageName?: string | null;
|
|
6106
5847
|
/**
|
|
6107
|
-
*
|
|
6108
|
-
*
|
|
6109
|
-
*
|
|
5848
|
+
* User-provided payment method name.
|
|
5849
|
+
*
|
|
5850
|
+
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
6110
5851
|
*/
|
|
6111
|
-
|
|
5852
|
+
userDefinedName?: UserDefinedPaymentMethodName;
|
|
6112
5853
|
}
|
|
6113
|
-
interface
|
|
5854
|
+
interface GiftCardPaymentDetails {
|
|
6114
5855
|
/**
|
|
6115
|
-
*
|
|
5856
|
+
* Gift card payment ID.
|
|
6116
5857
|
* @maxLength 100
|
|
6117
5858
|
*/
|
|
6118
|
-
|
|
5859
|
+
giftCardPaymentId?: string;
|
|
6119
5860
|
/**
|
|
6120
|
-
*
|
|
6121
|
-
*
|
|
6122
|
-
*
|
|
6123
|
-
* @maxLength 100
|
|
5861
|
+
* Gift card ID.
|
|
5862
|
+
* @internal
|
|
5863
|
+
* @deprecated
|
|
6124
5864
|
*/
|
|
6125
|
-
|
|
6126
|
-
}
|
|
6127
|
-
interface ChargeMembershipsResponse {
|
|
6128
|
-
}
|
|
6129
|
-
interface TriggerRefundRequest {
|
|
5865
|
+
giftCardId?: string;
|
|
6130
5866
|
/**
|
|
6131
|
-
*
|
|
6132
|
-
* @
|
|
6133
|
-
* @maxLength 100
|
|
5867
|
+
* ID of the app that created the gift card.
|
|
5868
|
+
* @format GUID
|
|
6134
5869
|
*/
|
|
6135
|
-
|
|
5870
|
+
appId?: string;
|
|
6136
5871
|
/**
|
|
6137
|
-
*
|
|
6138
|
-
* @
|
|
6139
|
-
* @
|
|
5872
|
+
* Whether the gift card is voided.
|
|
5873
|
+
* @readonly
|
|
5874
|
+
* @deprecated Whether the gift card is voided.
|
|
5875
|
+
* @replacedBy payment.status
|
|
5876
|
+
* @targetRemovalDate 2026-11-01
|
|
6140
5877
|
*/
|
|
6141
|
-
|
|
6142
|
-
/** Business model of a refund */
|
|
6143
|
-
details?: RefundDetails;
|
|
6144
|
-
/** Side effect details related to refund */
|
|
6145
|
-
sideEffects?: RefundSideEffects;
|
|
6146
|
-
}
|
|
6147
|
-
interface PaymentRefund {
|
|
5878
|
+
voided?: boolean;
|
|
6148
5879
|
/**
|
|
6149
|
-
*
|
|
6150
|
-
* @
|
|
5880
|
+
* Gift card code with all but the last four characters masked. For example, `************QXY1`.
|
|
5881
|
+
* @maxLength 30
|
|
5882
|
+
* @immutable
|
|
6151
5883
|
*/
|
|
6152
|
-
|
|
6153
|
-
|
|
6154
|
-
|
|
5884
|
+
obfuscatedCode?: string | null;
|
|
5885
|
+
}
|
|
5886
|
+
interface MembershipPaymentDetails {
|
|
6155
5887
|
/**
|
|
6156
|
-
*
|
|
6157
|
-
*
|
|
6158
|
-
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
5888
|
+
* Membership ID.
|
|
5889
|
+
* @maxLength 200
|
|
6159
5890
|
*/
|
|
6160
|
-
|
|
5891
|
+
membershipId?: string;
|
|
6161
5892
|
/**
|
|
6162
|
-
*
|
|
6163
|
-
* Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
|
|
6164
|
-
* and all side effects from request will be executed.
|
|
6165
|
-
* @internal
|
|
5893
|
+
* ID of the line item this membership applies to.
|
|
6166
5894
|
* @minLength 1
|
|
6167
5895
|
* @maxLength 100
|
|
6168
5896
|
*/
|
|
6169
|
-
|
|
6170
|
-
}
|
|
6171
|
-
interface RefundSideEffects {
|
|
6172
|
-
/** Inventory restock details as part of this refund. */
|
|
6173
|
-
restockInfo?: RestockInfo;
|
|
6174
|
-
/** Whether to send a refund confirmation email to the customer. */
|
|
6175
|
-
sendOrderRefundedEmail?: boolean;
|
|
5897
|
+
lineItemId?: string;
|
|
6176
5898
|
/**
|
|
6177
|
-
*
|
|
5899
|
+
* Payment status.
|
|
5900
|
+
* @deprecated Payment status.
|
|
5901
|
+
* @replacedBy payment.status
|
|
5902
|
+
* @targetRemovalDate 2026-11-01
|
|
5903
|
+
*/
|
|
5904
|
+
status?: MembershipPaymentStatusWithLiterals;
|
|
5905
|
+
/** Membership name. */
|
|
5906
|
+
name?: MembershipName;
|
|
5907
|
+
/**
|
|
5908
|
+
* The transaction ID in the membership system. Can be used to void the transaction.
|
|
6178
5909
|
* @minLength 1
|
|
6179
|
-
* @maxLength
|
|
5910
|
+
* @maxLength 100
|
|
6180
5911
|
*/
|
|
6181
|
-
|
|
6182
|
-
}
|
|
6183
|
-
interface RestockInfo {
|
|
6184
|
-
/** Restock type. */
|
|
6185
|
-
type?: RestockTypeWithLiterals;
|
|
5912
|
+
externalTransactionId?: string | null;
|
|
6186
5913
|
/**
|
|
6187
|
-
*
|
|
6188
|
-
* @
|
|
6189
|
-
* @
|
|
6190
|
-
* @
|
|
5914
|
+
* Whether the membership is voided.
|
|
5915
|
+
* @readonly
|
|
5916
|
+
* @deprecated Whether the membership is voided.
|
|
5917
|
+
* @replacedBy payment.status
|
|
5918
|
+
* @targetRemovalDate 2026-11-01
|
|
6191
5919
|
*/
|
|
6192
|
-
|
|
5920
|
+
voided?: boolean;
|
|
6193
5921
|
/**
|
|
6194
|
-
*
|
|
6195
|
-
* @
|
|
5922
|
+
* ID of the application providing this payment option.
|
|
5923
|
+
* @format GUID
|
|
6196
5924
|
*/
|
|
6197
|
-
|
|
5925
|
+
providerAppId?: string;
|
|
5926
|
+
/** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
|
|
5927
|
+
futureMembership?: FutureMembershipDetails;
|
|
6198
5928
|
}
|
|
6199
|
-
declare enum
|
|
6200
|
-
|
|
6201
|
-
|
|
6202
|
-
|
|
5929
|
+
declare enum MembershipPaymentStatus {
|
|
5930
|
+
/** Payment was charged. */
|
|
5931
|
+
CHARGED = "CHARGED",
|
|
5932
|
+
/** The attempt to charge the payment failed, for example, due to lack of credits. */
|
|
5933
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
5934
|
+
/** Payment is pending. */
|
|
5935
|
+
CHARGE_PENDING = "CHARGE_PENDING",
|
|
5936
|
+
/** Payment was voided. */
|
|
5937
|
+
VOIDED = "VOIDED"
|
|
6203
5938
|
}
|
|
6204
5939
|
/** @enumType */
|
|
6205
|
-
type
|
|
6206
|
-
interface
|
|
5940
|
+
type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
|
|
5941
|
+
interface FutureMembershipDetails {
|
|
6207
5942
|
/**
|
|
6208
|
-
* ID of the line item
|
|
5943
|
+
* ID of the plan line item in the order from which the membership will be created.
|
|
6209
5944
|
* @format GUID
|
|
6210
5945
|
*/
|
|
6211
5946
|
lineItemId?: string;
|
|
6212
5947
|
/**
|
|
6213
|
-
*
|
|
6214
|
-
* @
|
|
6215
|
-
* @max 100000
|
|
5948
|
+
* ID of the benefit the future membership will grant.
|
|
5949
|
+
* @maxLength 200
|
|
6216
5950
|
*/
|
|
6217
|
-
|
|
5951
|
+
benefitId?: string;
|
|
5952
|
+
}
|
|
5953
|
+
interface WixReceiptInfo {
|
|
6218
5954
|
/**
|
|
6219
|
-
*
|
|
6220
|
-
* @
|
|
6221
|
-
* @maxSize 5
|
|
5955
|
+
* Receipt ID
|
|
5956
|
+
* @format GUID
|
|
6222
5957
|
*/
|
|
6223
|
-
|
|
6224
|
-
|
|
6225
|
-
|
|
6226
|
-
|
|
6227
|
-
|
|
6228
|
-
|
|
6229
|
-
|
|
6230
|
-
/** Payment ID's that the refund execution had failed for */
|
|
6231
|
-
failedPaymentIds?: ItemMetadata[];
|
|
5958
|
+
receiptId?: string;
|
|
5959
|
+
/**
|
|
5960
|
+
* Display number of receipt
|
|
5961
|
+
* @minLength 1
|
|
5962
|
+
* @maxLength 40
|
|
5963
|
+
*/
|
|
5964
|
+
displayNumber?: string | null;
|
|
6232
5965
|
}
|
|
6233
|
-
|
|
6234
|
-
* A record of all payments and refunds associated with an order.
|
|
6235
|
-
*
|
|
6236
|
-
* Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
|
|
6237
|
-
*/
|
|
6238
|
-
interface OrderTransactions {
|
|
5966
|
+
interface ExternalReceiptInfo {
|
|
6239
5967
|
/**
|
|
6240
|
-
*
|
|
5968
|
+
* External receipt ID
|
|
5969
|
+
* @maxLength 100
|
|
5970
|
+
*/
|
|
5971
|
+
receiptId?: string | null;
|
|
5972
|
+
/**
|
|
5973
|
+
* ID of the app providing the receipt
|
|
6241
5974
|
* @format GUID
|
|
6242
5975
|
*/
|
|
6243
|
-
|
|
5976
|
+
appId?: string | null;
|
|
6244
5977
|
/**
|
|
6245
|
-
*
|
|
6246
|
-
* @
|
|
5978
|
+
* Display number of receipt
|
|
5979
|
+
* @minLength 1
|
|
5980
|
+
* @maxLength 40
|
|
6247
5981
|
*/
|
|
6248
|
-
|
|
5982
|
+
displayNumber?: string | null;
|
|
5983
|
+
}
|
|
5984
|
+
interface CashRoundingDetails {
|
|
6249
5985
|
/**
|
|
6250
|
-
*
|
|
6251
|
-
*
|
|
5986
|
+
* Payment amount before cash rounding was applied.
|
|
5987
|
+
* When provided, balance and status calculations use this value instead of `amount`
|
|
5988
|
+
* to prevent false overpayment or underpayment due to rounding.
|
|
6252
5989
|
*/
|
|
6253
|
-
|
|
5990
|
+
unroundedAmount?: Price;
|
|
5991
|
+
/**
|
|
5992
|
+
* The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
|
|
5993
|
+
* A positive value indicates the price was rounded up; a negative value indicates a round-down.
|
|
5994
|
+
* @readonly
|
|
5995
|
+
*/
|
|
5996
|
+
roundingAdjustment?: CashRounding;
|
|
5997
|
+
}
|
|
5998
|
+
declare enum PaymentStatus {
|
|
5999
|
+
/** Payment was charged successfully. */
|
|
6000
|
+
APPROVED = "APPROVED",
|
|
6001
|
+
/** Payment is being processed and hasn't been confirmed yet. */
|
|
6002
|
+
PENDING = "PENDING",
|
|
6003
|
+
/** 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. */
|
|
6004
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6005
|
+
/** Payment was canceled before it was charged. */
|
|
6006
|
+
CANCELED = "CANCELED",
|
|
6007
|
+
/** Payment was declined by the payment provider. */
|
|
6008
|
+
DECLINED = "DECLINED",
|
|
6009
|
+
/** Payment was fully refunded. */
|
|
6010
|
+
REFUNDED = "REFUNDED",
|
|
6011
|
+
/** Part of the payment amount was refunded. */
|
|
6012
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6013
|
+
/** 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. */
|
|
6014
|
+
AUTHORIZED = "AUTHORIZED",
|
|
6015
|
+
/**
|
|
6016
|
+
* Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
|
|
6017
|
+
*
|
|
6018
|
+
* Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
|
|
6019
|
+
*/
|
|
6020
|
+
VOIDED = "VOIDED"
|
|
6021
|
+
}
|
|
6022
|
+
/** @enumType */
|
|
6023
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6024
|
+
interface CanceledStatusDetails {
|
|
6025
|
+
reason?: CanceledReasonWithLiterals;
|
|
6026
|
+
}
|
|
6027
|
+
declare enum CanceledReason {
|
|
6028
|
+
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
6029
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
6030
|
+
/** Payment was not completed by user and expired. */
|
|
6031
|
+
EXPIRED = "EXPIRED"
|
|
6032
|
+
}
|
|
6033
|
+
/** @enumType */
|
|
6034
|
+
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
6035
|
+
interface DeclinedStatusDetails {
|
|
6036
|
+
reason?: DeclinedReasonWithLiterals;
|
|
6037
|
+
}
|
|
6038
|
+
declare enum DeclinedReason {
|
|
6039
|
+
/** Corresponding charge failed. */
|
|
6040
|
+
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6041
|
+
/** Payment details expired. */
|
|
6042
|
+
EXPIRED = "EXPIRED",
|
|
6043
|
+
/** Insufficient funds. */
|
|
6044
|
+
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6045
|
+
/** Gift card was disabled before charge was attempted. */
|
|
6046
|
+
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
6254
6047
|
}
|
|
6255
|
-
|
|
6256
|
-
|
|
6257
|
-
|
|
6258
|
-
|
|
6259
|
-
|
|
6260
|
-
|
|
6261
|
-
|
|
6262
|
-
|
|
6263
|
-
|
|
6264
|
-
|
|
6265
|
-
|
|
6266
|
-
|
|
6048
|
+
/** @enumType */
|
|
6049
|
+
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6050
|
+
interface VoidedStatusDetails {
|
|
6051
|
+
reason?: VoidedReasonWithLiterals;
|
|
6052
|
+
}
|
|
6053
|
+
declare enum VoidedReason {
|
|
6054
|
+
/** Payment was voided by merchant request. */
|
|
6055
|
+
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
6056
|
+
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
6057
|
+
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
6058
|
+
}
|
|
6059
|
+
/** @enumType */
|
|
6060
|
+
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
6061
|
+
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
6062
|
+
/** @internal */
|
|
6063
|
+
canceled?: CanceledStatusDetails;
|
|
6064
|
+
/** @internal */
|
|
6065
|
+
declined?: DeclinedStatusDetails;
|
|
6066
|
+
/** @internal */
|
|
6067
|
+
voided?: VoidedStatusDetails;
|
|
6267
6068
|
/**
|
|
6268
|
-
*
|
|
6069
|
+
* Reason code from the payment gateway.
|
|
6269
6070
|
* @internal
|
|
6071
|
+
* @minLength 1
|
|
6072
|
+
* @maxLength 10
|
|
6270
6073
|
*/
|
|
6271
|
-
|
|
6074
|
+
paymentGatewayReasonCode?: string | null;
|
|
6075
|
+
}
|
|
6076
|
+
/** @oneof */
|
|
6077
|
+
interface PaymentStatusDetailsStatusDetailsOneOf {
|
|
6272
6078
|
/** @internal */
|
|
6273
6079
|
canceled?: CanceledStatusDetails;
|
|
6274
6080
|
/** @internal */
|
|
6275
6081
|
declined?: DeclinedStatusDetails;
|
|
6276
6082
|
/** @internal */
|
|
6277
6083
|
voided?: VoidedStatusDetails;
|
|
6084
|
+
}
|
|
6085
|
+
interface Refund {
|
|
6278
6086
|
/**
|
|
6279
|
-
*
|
|
6087
|
+
* Refund ID.
|
|
6280
6088
|
* @format GUID
|
|
6281
6089
|
* @readonly
|
|
6282
6090
|
*/
|
|
6283
|
-
_id?: string
|
|
6284
|
-
/** 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. */
|
|
6285
|
-
_createdDate?: Date | null;
|
|
6091
|
+
_id?: string;
|
|
6286
6092
|
/**
|
|
6287
|
-
*
|
|
6093
|
+
* List of transactions.
|
|
6094
|
+
* @maxSize 50
|
|
6095
|
+
*/
|
|
6096
|
+
transactions?: RefundTransaction[];
|
|
6097
|
+
/** Refund business details. */
|
|
6098
|
+
details?: RefundDetails;
|
|
6099
|
+
/**
|
|
6100
|
+
* 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.
|
|
6288
6101
|
* @readonly
|
|
6102
|
+
* @immutable
|
|
6289
6103
|
*/
|
|
6290
|
-
|
|
6291
|
-
/** Payment amount. */
|
|
6292
|
-
amount?: Price;
|
|
6104
|
+
_createdDate?: Date | null;
|
|
6293
6105
|
/**
|
|
6294
|
-
*
|
|
6295
|
-
*
|
|
6296
|
-
*
|
|
6106
|
+
* Aggregated refund summary.
|
|
6107
|
+
*
|
|
6108
|
+
* The refunded amount of this refund is in `summary.refunded`. To get the total refunded across the whole order, use `balanceSummary.refunded` on the order instead.
|
|
6109
|
+
* @readonly
|
|
6297
6110
|
*/
|
|
6298
|
-
|
|
6111
|
+
summary?: AggregatedRefundSummary;
|
|
6299
6112
|
/**
|
|
6300
|
-
*
|
|
6301
|
-
*
|
|
6302
|
-
* + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
|
|
6113
|
+
* ID of the app that initiated this refund.
|
|
6114
|
+
* @format GUID
|
|
6303
6115
|
* @readonly
|
|
6116
|
+
* @immutable
|
|
6304
6117
|
*/
|
|
6305
|
-
|
|
6306
|
-
|
|
6307
|
-
|
|
6118
|
+
requestingServiceAppId?: string | null;
|
|
6119
|
+
}
|
|
6120
|
+
interface RefundTransaction {
|
|
6308
6121
|
/**
|
|
6309
|
-
*
|
|
6310
|
-
*
|
|
6311
|
-
*
|
|
6122
|
+
* ID of the payment associated with this refund.
|
|
6123
|
+
* @format GUID
|
|
6124
|
+
* @immutable
|
|
6312
6125
|
*/
|
|
6313
|
-
|
|
6126
|
+
paymentId?: string;
|
|
6314
6127
|
/**
|
|
6315
|
-
*
|
|
6316
|
-
* @
|
|
6128
|
+
* Refund amount.
|
|
6129
|
+
* @immutable
|
|
6317
6130
|
*/
|
|
6318
|
-
|
|
6131
|
+
amount?: Price;
|
|
6132
|
+
/** Refund status. */
|
|
6133
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
6134
|
+
/** Optional details of current refund status. */
|
|
6135
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
6319
6136
|
/**
|
|
6320
|
-
*
|
|
6137
|
+
* Payment gateway's refund ID.
|
|
6138
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
6139
|
+
* @format GUID
|
|
6140
|
+
*/
|
|
6141
|
+
gatewayRefundId?: string | null;
|
|
6142
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
6143
|
+
providerRefundId?: string | null;
|
|
6144
|
+
/**
|
|
6145
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
6146
|
+
* @immutable
|
|
6147
|
+
*/
|
|
6148
|
+
externalRefund?: boolean;
|
|
6149
|
+
/**
|
|
6150
|
+
* Location where the refund was processed.
|
|
6321
6151
|
* @internal
|
|
6322
6152
|
* @format GUID
|
|
6323
6153
|
* @immutable
|
|
6324
6154
|
*/
|
|
6325
6155
|
locationId?: string | null;
|
|
6156
|
+
}
|
|
6157
|
+
/** Refund transaction status. */
|
|
6158
|
+
declare enum RefundStatus {
|
|
6159
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
6160
|
+
PENDING = "PENDING",
|
|
6161
|
+
/** Refund transaction succeeded. */
|
|
6162
|
+
SUCCEEDED = "SUCCEEDED",
|
|
6163
|
+
/** Refund transaction failed. */
|
|
6164
|
+
FAILED = "FAILED",
|
|
6165
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
6166
|
+
SCHEDULED = "SCHEDULED",
|
|
6167
|
+
/** Refund was initiated on payment provider side. */
|
|
6168
|
+
STARTED = "STARTED"
|
|
6169
|
+
}
|
|
6170
|
+
/** @enumType */
|
|
6171
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
6172
|
+
interface RefundStatusInfo {
|
|
6326
6173
|
/**
|
|
6327
|
-
*
|
|
6174
|
+
* Reason code for the refund's current status.
|
|
6175
|
+
*
|
|
6176
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
6177
|
+
* @minLength 1
|
|
6178
|
+
* @maxLength 10
|
|
6179
|
+
*/
|
|
6180
|
+
paymentGatewayReasonCode?: string | null;
|
|
6181
|
+
/**
|
|
6182
|
+
* Free text explanation of current refund status.
|
|
6183
|
+
* @minLength 1
|
|
6184
|
+
* @maxLength 1000
|
|
6185
|
+
*/
|
|
6186
|
+
description?: string | null;
|
|
6187
|
+
}
|
|
6188
|
+
interface AggregatedRefundSummary {
|
|
6189
|
+
/** Total amount requested for refund. */
|
|
6190
|
+
requestedRefund?: Price;
|
|
6191
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
6192
|
+
pendingRefund?: Price;
|
|
6193
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
6194
|
+
refunded?: Price;
|
|
6195
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6196
|
+
failedRefundAmount?: Price;
|
|
6197
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6198
|
+
pending?: boolean;
|
|
6199
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6200
|
+
breakdown?: RefundItemsBreakdown;
|
|
6201
|
+
}
|
|
6202
|
+
interface RefundItemsBreakdown {
|
|
6203
|
+
/**
|
|
6204
|
+
* Refunded line items and the amount refunded for each.
|
|
6205
|
+
* @maxSize 300
|
|
6206
|
+
*/
|
|
6207
|
+
lineItems?: LineItemRefundSummary[];
|
|
6208
|
+
}
|
|
6209
|
+
interface LineItemRefundSummary {
|
|
6210
|
+
/**
|
|
6211
|
+
* ID of the refunded line item.
|
|
6328
6212
|
* @format GUID
|
|
6329
6213
|
*/
|
|
6330
|
-
|
|
6214
|
+
lineItemId?: string;
|
|
6215
|
+
/** Total refunded amount for the line item. */
|
|
6216
|
+
totalRefundedAmount?: Price;
|
|
6331
6217
|
}
|
|
6332
|
-
|
|
6333
|
-
|
|
6334
|
-
|
|
6335
|
-
|
|
6336
|
-
|
|
6337
|
-
|
|
6338
|
-
|
|
6339
|
-
|
|
6218
|
+
interface CalculateRefundRequest {
|
|
6219
|
+
/**
|
|
6220
|
+
* Order ID
|
|
6221
|
+
* @minLength 1
|
|
6222
|
+
* @maxLength 100
|
|
6223
|
+
*/
|
|
6224
|
+
ecomOrderId?: string;
|
|
6225
|
+
/**
|
|
6226
|
+
* Refunded line items and quantity
|
|
6227
|
+
* @maxSize 300
|
|
6228
|
+
*/
|
|
6229
|
+
refundItems?: CalculateRefundItemRequest[];
|
|
6230
|
+
/** Should include shipping in refund calculation */
|
|
6231
|
+
refundShipping?: boolean;
|
|
6340
6232
|
}
|
|
6341
|
-
|
|
6342
|
-
interface PaymentReceiptInfoOneOf {
|
|
6233
|
+
interface CalculateRefundItemRequest {
|
|
6343
6234
|
/**
|
|
6344
|
-
*
|
|
6345
|
-
* @
|
|
6235
|
+
* ID of the line item being refunded
|
|
6236
|
+
* @format GUID
|
|
6346
6237
|
*/
|
|
6347
|
-
|
|
6238
|
+
_id?: string;
|
|
6348
6239
|
/**
|
|
6349
|
-
*
|
|
6350
|
-
* @
|
|
6240
|
+
* How much of that line item is being refunded
|
|
6241
|
+
* @min 1
|
|
6242
|
+
* @max 100000
|
|
6351
6243
|
*/
|
|
6352
|
-
|
|
6244
|
+
quantity?: number;
|
|
6353
6245
|
}
|
|
6354
|
-
|
|
6355
|
-
|
|
6356
|
-
|
|
6357
|
-
|
|
6358
|
-
|
|
6359
|
-
|
|
6360
|
-
|
|
6361
|
-
|
|
6246
|
+
interface CalculateRefundResponse {
|
|
6247
|
+
/** Total refundable amount */
|
|
6248
|
+
total?: Price;
|
|
6249
|
+
/** Tax cost of the order */
|
|
6250
|
+
tax?: Price;
|
|
6251
|
+
/** Discount given for this order */
|
|
6252
|
+
discount?: Price;
|
|
6253
|
+
/** Total cost of the order (without tax) */
|
|
6254
|
+
subtotal?: Price;
|
|
6255
|
+
/** Total shipping cost for order */
|
|
6256
|
+
shipping?: Price;
|
|
6257
|
+
/** Previous refund given on that order */
|
|
6258
|
+
previouslyRefundedAmount?: Price;
|
|
6259
|
+
/**
|
|
6260
|
+
* The refundable items of that order
|
|
6261
|
+
* @maxSize 300
|
|
6262
|
+
*/
|
|
6263
|
+
items?: CalculateRefundItemResponse[];
|
|
6362
6264
|
}
|
|
6363
|
-
interface
|
|
6364
|
-
/** Credit card details. */
|
|
6365
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
6265
|
+
interface CalculateRefundItemResponse {
|
|
6366
6266
|
/**
|
|
6367
|
-
*
|
|
6368
|
-
* @
|
|
6267
|
+
* Line item ID
|
|
6268
|
+
* @format GUID
|
|
6369
6269
|
*/
|
|
6370
|
-
|
|
6270
|
+
_id?: string;
|
|
6271
|
+
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
6272
|
+
price?: Price;
|
|
6273
|
+
}
|
|
6274
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
6371
6275
|
/**
|
|
6372
|
-
*
|
|
6373
|
-
*
|
|
6276
|
+
* Wix eCommerce order ID
|
|
6277
|
+
* @minLength 1
|
|
6374
6278
|
* @maxLength 100
|
|
6375
6279
|
*/
|
|
6376
|
-
|
|
6280
|
+
ecomOrderId: string;
|
|
6377
6281
|
/**
|
|
6378
|
-
* Payment
|
|
6379
|
-
*
|
|
6380
|
-
*
|
|
6381
|
-
*
|
|
6382
|
-
* @maxLength 150
|
|
6383
|
-
* @deprecated Payment method.
|
|
6384
|
-
* Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
|
|
6385
|
-
* Non-exhaustive list of supported values:
|
|
6386
|
-
* + `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`
|
|
6387
|
-
* @replacedBy payment_method_name
|
|
6388
|
-
* @targetRemovalDate 2026-07-01
|
|
6282
|
+
* Payment IDs
|
|
6283
|
+
* @minSize 1
|
|
6284
|
+
* @maxSize 100
|
|
6285
|
+
* @format GUID
|
|
6389
6286
|
*/
|
|
6390
|
-
|
|
6287
|
+
paymentIds: string[];
|
|
6288
|
+
}
|
|
6289
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
6290
|
+
/** All order's transactions after the void was triggered */
|
|
6291
|
+
orderTransactions?: OrderTransactions;
|
|
6292
|
+
}
|
|
6293
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
6391
6294
|
/**
|
|
6392
|
-
*
|
|
6295
|
+
* Wix eCommerce order ID
|
|
6296
|
+
* @minLength 1
|
|
6393
6297
|
* @maxLength 100
|
|
6394
6298
|
*/
|
|
6395
|
-
|
|
6396
|
-
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
6397
|
-
offlinePayment?: boolean;
|
|
6398
|
-
/**
|
|
6399
|
-
* Payment status.
|
|
6400
|
-
* @deprecated Payment status.
|
|
6401
|
-
* @replacedBy payment.status
|
|
6402
|
-
* @targetRemovalDate 2026-11-01
|
|
6403
|
-
*/
|
|
6404
|
-
status?: TransactionStatusWithLiterals;
|
|
6405
|
-
/** Whether there is a payment agreement that allows for future charges. */
|
|
6406
|
-
savedPaymentMethod?: boolean;
|
|
6407
|
-
/** Authorization details. */
|
|
6408
|
-
authorizationDetails?: AuthorizationDetails;
|
|
6299
|
+
ecomOrderId: string;
|
|
6409
6300
|
/**
|
|
6410
|
-
*
|
|
6411
|
-
* @
|
|
6412
|
-
* @
|
|
6301
|
+
* Capture payments information
|
|
6302
|
+
* @minSize 1
|
|
6303
|
+
* @maxSize 100
|
|
6413
6304
|
*/
|
|
6414
|
-
|
|
6305
|
+
payments: PaymentCapture[];
|
|
6306
|
+
}
|
|
6307
|
+
interface PaymentCapture {
|
|
6415
6308
|
/**
|
|
6416
|
-
*
|
|
6417
|
-
* @
|
|
6309
|
+
* Payment ID
|
|
6310
|
+
* @format GUID
|
|
6418
6311
|
*/
|
|
6419
|
-
|
|
6312
|
+
paymentId?: string | null;
|
|
6420
6313
|
/**
|
|
6421
|
-
*
|
|
6422
|
-
*
|
|
6423
|
-
* @maxLength 36
|
|
6314
|
+
* Capture amount.
|
|
6315
|
+
* If not provided - full authorized amount will be captured.
|
|
6424
6316
|
*/
|
|
6425
|
-
|
|
6426
|
-
|
|
6427
|
-
|
|
6317
|
+
amount?: Price;
|
|
6318
|
+
}
|
|
6319
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
6320
|
+
/** All order's transactions after the capture was triggered */
|
|
6321
|
+
orderTransactions?: OrderTransactions;
|
|
6322
|
+
}
|
|
6323
|
+
interface ChargeSavedPaymentMethodRequest {
|
|
6428
6324
|
/**
|
|
6429
|
-
*
|
|
6430
|
-
*
|
|
6431
|
-
*
|
|
6325
|
+
* Ecom Order ID.
|
|
6326
|
+
* @minLength 1
|
|
6327
|
+
* @maxLength 100
|
|
6432
6328
|
*/
|
|
6433
|
-
|
|
6329
|
+
ecomOrderId?: string;
|
|
6330
|
+
/** Amount to be charged */
|
|
6331
|
+
amount?: Price;
|
|
6434
6332
|
}
|
|
6435
|
-
|
|
6436
|
-
|
|
6437
|
-
|
|
6438
|
-
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
6333
|
+
interface ChargeSavedPaymentMethodResponse {
|
|
6334
|
+
/** Payment gateway's order ID (e.g Wix Payments) */
|
|
6335
|
+
paymentGatewayOrderId?: string;
|
|
6439
6336
|
}
|
|
6440
|
-
|
|
6441
|
-
|
|
6442
|
-
|
|
6443
|
-
PENDING = "PENDING",
|
|
6444
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6445
|
-
CANCELED = "CANCELED",
|
|
6446
|
-
DECLINED = "DECLINED",
|
|
6447
|
-
REFUNDED = "REFUNDED",
|
|
6448
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6449
|
-
AUTHORIZED = "AUTHORIZED",
|
|
6450
|
-
VOIDED = "VOIDED"
|
|
6337
|
+
interface SendBuyerConfirmationEmailRequest {
|
|
6338
|
+
/** @format GUID */
|
|
6339
|
+
orderId?: string;
|
|
6451
6340
|
}
|
|
6452
|
-
|
|
6453
|
-
|
|
6454
|
-
interface
|
|
6455
|
-
/**
|
|
6456
|
-
* The last 4 digits of the card number.
|
|
6457
|
-
* @maxLength 4
|
|
6458
|
-
*/
|
|
6459
|
-
lastFourDigits?: string | null;
|
|
6341
|
+
interface SendBuyerConfirmationEmailResponse {
|
|
6342
|
+
}
|
|
6343
|
+
interface SendBuyerPaymentsReceivedEmailRequest {
|
|
6460
6344
|
/**
|
|
6461
|
-
*
|
|
6345
|
+
* @minLength 1
|
|
6462
6346
|
* @maxLength 100
|
|
6463
6347
|
*/
|
|
6464
|
-
|
|
6348
|
+
orderId?: string;
|
|
6465
6349
|
}
|
|
6466
|
-
interface
|
|
6467
|
-
/**
|
|
6468
|
-
* Whether the authorized payment is of a delayed capture.
|
|
6469
|
-
* @readonly
|
|
6470
|
-
*/
|
|
6471
|
-
delayedCapture?: boolean;
|
|
6472
|
-
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6473
|
-
authorizedDate?: Date | null;
|
|
6474
|
-
/**
|
|
6475
|
-
* List of captures associated with payment
|
|
6476
|
-
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
6477
|
-
* @maxSize 1
|
|
6478
|
-
*/
|
|
6479
|
-
captures?: AuthorizationCapture[];
|
|
6480
|
-
/** Void associated with payment */
|
|
6481
|
-
void?: AuthorizationVoid;
|
|
6482
|
-
/** Scheduled action for this transaction */
|
|
6483
|
-
scheduledAction?: V1ScheduledAction;
|
|
6350
|
+
interface SendBuyerPaymentsReceivedEmailResponse {
|
|
6484
6351
|
}
|
|
6485
|
-
interface
|
|
6352
|
+
interface SendBuyerPickupConfirmationEmailRequest {
|
|
6486
6353
|
/**
|
|
6487
|
-
*
|
|
6488
|
-
* @
|
|
6489
|
-
* @readonly
|
|
6354
|
+
* @minLength 1
|
|
6355
|
+
* @maxLength 100
|
|
6490
6356
|
*/
|
|
6491
|
-
|
|
6492
|
-
|
|
6493
|
-
|
|
6357
|
+
orderId?: string;
|
|
6358
|
+
}
|
|
6359
|
+
interface SendBuyerPickupConfirmationEmailResponse {
|
|
6360
|
+
}
|
|
6361
|
+
interface BulkSendBuyerPickupConfirmationEmailsRequest {
|
|
6494
6362
|
/**
|
|
6495
|
-
*
|
|
6496
|
-
* @
|
|
6363
|
+
* IDs of orders to send pickup emails for.
|
|
6364
|
+
* @minSize 1
|
|
6365
|
+
* @maxSize 300
|
|
6497
6366
|
*/
|
|
6498
|
-
|
|
6499
|
-
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6500
|
-
_createdDate?: Date | null;
|
|
6501
|
-
/** In case of status is FAILED may contain failure details */
|
|
6502
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6367
|
+
orderIds?: string[];
|
|
6503
6368
|
}
|
|
6504
|
-
|
|
6505
|
-
/** Capture operation still in progress. */
|
|
6506
|
-
PENDING = "PENDING",
|
|
6507
|
-
/** Capture operation succeeded. */
|
|
6508
|
-
SUCCEEDED = "SUCCEEDED",
|
|
6509
|
-
/** Capture operation failed. */
|
|
6510
|
-
FAILED = "FAILED"
|
|
6369
|
+
interface BulkSendBuyerPickupConfirmationEmailsResponse {
|
|
6511
6370
|
}
|
|
6512
|
-
|
|
6513
|
-
|
|
6514
|
-
|
|
6515
|
-
|
|
6516
|
-
|
|
6371
|
+
interface SendBuyerShippingConfirmationEmailRequest {
|
|
6372
|
+
/**
|
|
6373
|
+
* @minLength 1
|
|
6374
|
+
* @maxLength 100
|
|
6375
|
+
*/
|
|
6376
|
+
orderId?: string;
|
|
6517
6377
|
}
|
|
6518
|
-
interface
|
|
6519
|
-
/** Status of this void action */
|
|
6520
|
-
status?: AuthorizationVoidStatusWithLiterals;
|
|
6521
|
-
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
6522
|
-
voidedDate?: Date | null;
|
|
6523
|
-
/** In case of status is FAILED may contain failure details */
|
|
6524
|
-
failureDetails?: AuthorizationActionFailureDetails;
|
|
6525
|
-
/** Reason of void action */
|
|
6526
|
-
reason?: ReasonWithLiterals;
|
|
6378
|
+
interface SendBuyerShippingConfirmationEmailResponse {
|
|
6527
6379
|
}
|
|
6528
|
-
|
|
6529
|
-
/**
|
|
6530
|
-
|
|
6531
|
-
|
|
6532
|
-
|
|
6533
|
-
|
|
6534
|
-
|
|
6380
|
+
interface BulkSendBuyerShippingConfirmationEmailsRequest {
|
|
6381
|
+
/**
|
|
6382
|
+
* IDs of orders to send pickup emails for.
|
|
6383
|
+
* @minSize 1
|
|
6384
|
+
* @maxSize 300
|
|
6385
|
+
*/
|
|
6386
|
+
orderIds?: string[];
|
|
6535
6387
|
}
|
|
6536
|
-
|
|
6537
|
-
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
6538
|
-
/** Reason the authorization was voided. */
|
|
6539
|
-
declare enum Reason {
|
|
6540
|
-
/** Authorization was voided by user. */
|
|
6541
|
-
MANUAL = "MANUAL",
|
|
6542
|
-
/** Authorization passed execution date. */
|
|
6543
|
-
SCHEDULED = "SCHEDULED"
|
|
6388
|
+
interface BulkSendBuyerShippingConfirmationEmailsResponse {
|
|
6544
6389
|
}
|
|
6545
|
-
|
|
6546
|
-
|
|
6547
|
-
|
|
6548
|
-
|
|
6549
|
-
|
|
6550
|
-
|
|
6551
|
-
executionDate?: Date | null;
|
|
6390
|
+
interface SendMerchantOrderReceivedNotificationRequest {
|
|
6391
|
+
/**
|
|
6392
|
+
* @minLength 1
|
|
6393
|
+
* @maxLength 100
|
|
6394
|
+
*/
|
|
6395
|
+
orderId?: string;
|
|
6552
6396
|
}
|
|
6553
|
-
|
|
6554
|
-
VOID = "VOID",
|
|
6555
|
-
CAPTURE = "CAPTURE"
|
|
6397
|
+
interface SendMerchantOrderReceivedNotificationResponse {
|
|
6556
6398
|
}
|
|
6557
|
-
|
|
6558
|
-
type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
|
|
6559
|
-
interface Chargeback {
|
|
6399
|
+
interface SendCancelRefundEmailRequest {
|
|
6560
6400
|
/**
|
|
6561
|
-
*
|
|
6562
|
-
* @
|
|
6563
|
-
* @
|
|
6564
|
-
* @immutable
|
|
6401
|
+
* The ID of order that is canceled/refunded
|
|
6402
|
+
* @minLength 1
|
|
6403
|
+
* @maxLength 100
|
|
6565
6404
|
*/
|
|
6566
|
-
|
|
6405
|
+
orderId?: string;
|
|
6567
6406
|
/**
|
|
6568
|
-
*
|
|
6569
|
-
* @
|
|
6570
|
-
* @
|
|
6407
|
+
* Personal note added to the email (optional)
|
|
6408
|
+
* @minLength 1
|
|
6409
|
+
* @maxLength 1000
|
|
6571
6410
|
*/
|
|
6572
|
-
|
|
6411
|
+
customMessage?: string | null;
|
|
6412
|
+
/** Refund amount */
|
|
6413
|
+
refundAmount?: Price;
|
|
6573
6414
|
/**
|
|
6574
|
-
*
|
|
6575
|
-
* @
|
|
6415
|
+
* Refund ID. (Optional)
|
|
6416
|
+
* @format GUID
|
|
6576
6417
|
*/
|
|
6577
|
-
|
|
6418
|
+
refundId?: string | null;
|
|
6419
|
+
}
|
|
6420
|
+
interface SendCancelRefundEmailResponse {
|
|
6421
|
+
}
|
|
6422
|
+
interface SendRefundEmailRequest {
|
|
6578
6423
|
/**
|
|
6579
|
-
*
|
|
6580
|
-
* @
|
|
6581
|
-
* @immutable
|
|
6424
|
+
* The ID of order that is refunded
|
|
6425
|
+
* @format GUID
|
|
6582
6426
|
*/
|
|
6583
|
-
|
|
6427
|
+
orderId?: string;
|
|
6584
6428
|
/**
|
|
6585
|
-
*
|
|
6586
|
-
* @
|
|
6429
|
+
* Refund ID
|
|
6430
|
+
* @format GUID
|
|
6587
6431
|
*/
|
|
6588
|
-
|
|
6432
|
+
refundId?: string;
|
|
6589
6433
|
/**
|
|
6590
|
-
*
|
|
6591
|
-
*
|
|
6592
|
-
*
|
|
6434
|
+
* Personal note added to the email (optional)
|
|
6435
|
+
* @minLength 1
|
|
6436
|
+
* @maxLength 1000
|
|
6593
6437
|
*/
|
|
6594
|
-
|
|
6438
|
+
customMessage?: string | null;
|
|
6439
|
+
}
|
|
6440
|
+
interface SendRefundEmailResponse {
|
|
6441
|
+
}
|
|
6442
|
+
interface SendFulfillmentEmailRequest {
|
|
6443
|
+
/** @format GUID */
|
|
6444
|
+
orderId?: string;
|
|
6445
|
+
/** @format GUID */
|
|
6446
|
+
fulfillerId?: string;
|
|
6447
|
+
}
|
|
6448
|
+
interface SendFulfillmentEmailResponse {
|
|
6449
|
+
}
|
|
6450
|
+
interface SendMerchantOrderReceivedPushRequest {
|
|
6595
6451
|
/**
|
|
6596
|
-
*
|
|
6597
|
-
* @
|
|
6598
|
-
* @readonly
|
|
6599
|
-
* @immutable
|
|
6452
|
+
* @minLength 1
|
|
6453
|
+
* @maxLength 100
|
|
6600
6454
|
*/
|
|
6601
|
-
|
|
6455
|
+
orderId?: string;
|
|
6602
6456
|
}
|
|
6603
|
-
|
|
6604
|
-
|
|
6605
|
-
|
|
6606
|
-
|
|
6607
|
-
|
|
6457
|
+
interface SendMerchantOrderReceivedPushResponse {
|
|
6458
|
+
}
|
|
6459
|
+
interface PreviewEmailByTypeRequest {
|
|
6460
|
+
emailType?: PreviewEmailTypeWithLiterals;
|
|
6461
|
+
}
|
|
6462
|
+
declare enum PreviewEmailType {
|
|
6463
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
6464
|
+
DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
|
|
6465
|
+
ORDER_SHIPPED = "ORDER_SHIPPED",
|
|
6466
|
+
ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
|
|
6608
6467
|
}
|
|
6609
6468
|
/** @enumType */
|
|
6610
|
-
type
|
|
6611
|
-
interface
|
|
6469
|
+
type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
|
|
6470
|
+
interface PreviewEmailByTypeResponse {
|
|
6471
|
+
emailPreview?: string;
|
|
6472
|
+
}
|
|
6473
|
+
interface PreviewRefundEmailRequest {
|
|
6612
6474
|
/**
|
|
6613
|
-
*
|
|
6614
|
-
* @maxLength
|
|
6475
|
+
* @minLength 1
|
|
6476
|
+
* @maxLength 100
|
|
6615
6477
|
*/
|
|
6616
|
-
|
|
6478
|
+
orderId?: string;
|
|
6479
|
+
/** Refund amount */
|
|
6480
|
+
refundAmount?: Price;
|
|
6481
|
+
/** Refund business details */
|
|
6482
|
+
details?: RefundDetails;
|
|
6617
6483
|
/**
|
|
6618
|
-
*
|
|
6619
|
-
*
|
|
6620
|
-
*
|
|
6621
|
-
* @maxLength 150
|
|
6484
|
+
* Personal note added to the email (optional)
|
|
6485
|
+
* @minLength 1
|
|
6486
|
+
* @maxLength 1000
|
|
6622
6487
|
*/
|
|
6623
|
-
|
|
6488
|
+
customMessage?: string | null;
|
|
6624
6489
|
/**
|
|
6625
|
-
*
|
|
6626
|
-
*
|
|
6627
|
-
* When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
|
|
6490
|
+
* Refund ID. (Optional)
|
|
6491
|
+
* @format GUID
|
|
6628
6492
|
*/
|
|
6629
|
-
|
|
6493
|
+
refundId?: string | null;
|
|
6630
6494
|
}
|
|
6631
|
-
interface
|
|
6495
|
+
interface PreviewRefundEmailResponse {
|
|
6496
|
+
emailPreview?: string;
|
|
6497
|
+
}
|
|
6498
|
+
interface PreviewCancelEmailRequest {
|
|
6632
6499
|
/**
|
|
6633
|
-
*
|
|
6500
|
+
* @minLength 1
|
|
6634
6501
|
* @maxLength 100
|
|
6635
6502
|
*/
|
|
6636
|
-
|
|
6503
|
+
orderId?: string;
|
|
6637
6504
|
/**
|
|
6638
|
-
*
|
|
6639
|
-
* @
|
|
6640
|
-
* @
|
|
6505
|
+
* Personal note added to the email (optional)
|
|
6506
|
+
* @minLength 1
|
|
6507
|
+
* @maxLength 1000
|
|
6641
6508
|
*/
|
|
6642
|
-
|
|
6509
|
+
customMessage?: string | null;
|
|
6510
|
+
}
|
|
6511
|
+
interface PreviewCancelEmailResponse {
|
|
6512
|
+
emailPreview?: string;
|
|
6513
|
+
}
|
|
6514
|
+
interface PreviewCancelRefundEmailRequest {
|
|
6643
6515
|
/**
|
|
6644
|
-
*
|
|
6645
|
-
* @
|
|
6516
|
+
* @minLength 1
|
|
6517
|
+
* @maxLength 100
|
|
6646
6518
|
*/
|
|
6647
|
-
|
|
6519
|
+
orderId?: string;
|
|
6648
6520
|
/**
|
|
6649
|
-
*
|
|
6650
|
-
* @
|
|
6651
|
-
* @
|
|
6652
|
-
* @replacedBy payment.status
|
|
6653
|
-
* @targetRemovalDate 2026-11-01
|
|
6521
|
+
* Personal note added to the email (optional)
|
|
6522
|
+
* @minLength 1
|
|
6523
|
+
* @maxLength 1000
|
|
6654
6524
|
*/
|
|
6655
|
-
|
|
6525
|
+
customMessage?: string | null;
|
|
6526
|
+
/** Refund amount */
|
|
6527
|
+
refundAmount?: Price;
|
|
6656
6528
|
/**
|
|
6657
|
-
*
|
|
6658
|
-
* @
|
|
6659
|
-
* @immutable
|
|
6529
|
+
* Refund ID. (Optional)
|
|
6530
|
+
* @format GUID
|
|
6660
6531
|
*/
|
|
6661
|
-
|
|
6532
|
+
refundId?: string | null;
|
|
6662
6533
|
}
|
|
6663
|
-
interface
|
|
6534
|
+
interface PreviewCancelRefundEmailResponse {
|
|
6535
|
+
emailPreview?: string;
|
|
6536
|
+
}
|
|
6537
|
+
interface PreviewBuyerPaymentsReceivedEmailRequest {
|
|
6538
|
+
}
|
|
6539
|
+
interface PreviewBuyerPaymentsReceivedEmailResponse {
|
|
6540
|
+
emailPreview?: string;
|
|
6541
|
+
}
|
|
6542
|
+
interface PreviewBuyerConfirmationEmailRequest {
|
|
6543
|
+
}
|
|
6544
|
+
interface PreviewBuyerConfirmationEmailResponse {
|
|
6545
|
+
emailPreview?: string;
|
|
6546
|
+
}
|
|
6547
|
+
interface PreviewBuyerPickupConfirmationEmailRequest {
|
|
6548
|
+
}
|
|
6549
|
+
interface PreviewBuyerPickupConfirmationEmailResponse {
|
|
6550
|
+
emailPreview?: string;
|
|
6551
|
+
}
|
|
6552
|
+
interface PreviewShippingConfirmationEmailRequest {
|
|
6553
|
+
}
|
|
6554
|
+
interface PreviewShippingConfirmationEmailResponse {
|
|
6555
|
+
emailPreview?: string;
|
|
6556
|
+
}
|
|
6557
|
+
interface PreviewResendDownloadLinksEmailRequest {
|
|
6558
|
+
}
|
|
6559
|
+
interface PreviewResendDownloadLinksEmailResponse {
|
|
6560
|
+
emailPreview?: string;
|
|
6561
|
+
}
|
|
6562
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
6563
|
+
/** Emitted on a meta site creation. */
|
|
6564
|
+
siteCreated?: SiteCreated;
|
|
6565
|
+
/** Emitted on a meta site transfer completion. */
|
|
6566
|
+
siteTransferred?: SiteTransferred;
|
|
6567
|
+
/** Emitted on a meta site deletion. */
|
|
6568
|
+
siteDeleted?: SiteDeleted;
|
|
6569
|
+
/** Emitted on a meta site restoration. */
|
|
6570
|
+
siteUndeleted?: SiteUndeleted;
|
|
6571
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6572
|
+
sitePublished?: SitePublished;
|
|
6573
|
+
/** Emitted on a meta site unpublish. */
|
|
6574
|
+
siteUnpublished?: SiteUnpublished;
|
|
6575
|
+
/** Emitted when meta site is marked as template. */
|
|
6576
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6577
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6578
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6579
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6580
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6581
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6582
|
+
serviceRemoved?: ServiceRemoved;
|
|
6583
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6584
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6585
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6586
|
+
hardDeleted?: SiteHardDeleted;
|
|
6587
|
+
/** Emitted on a namespace change. */
|
|
6588
|
+
namespaceChanged?: NamespaceChanged;
|
|
6589
|
+
/** Emitted when Studio is attached. */
|
|
6590
|
+
studioAssigned?: StudioAssigned;
|
|
6591
|
+
/** Emitted when Studio is detached. */
|
|
6592
|
+
studioUnassigned?: StudioUnassigned;
|
|
6664
6593
|
/**
|
|
6665
|
-
*
|
|
6666
|
-
*
|
|
6594
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6595
|
+
* the actual URL.
|
|
6596
|
+
*
|
|
6597
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6598
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6667
6599
|
*/
|
|
6668
|
-
|
|
6600
|
+
urlChanged?: SiteUrlChanged;
|
|
6601
|
+
/** Site is marked as PurgedExternally */
|
|
6602
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6603
|
+
/** Emitted when Odeditor is attached. */
|
|
6604
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6605
|
+
/** Emitted when Odeditor is detached. */
|
|
6606
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6607
|
+
/** Emitted when Picasso is attached. */
|
|
6608
|
+
picassoAssigned?: PicassoAssigned;
|
|
6609
|
+
/** Emitted when Picasso is detached. */
|
|
6610
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6611
|
+
/** Emitted when Wixel is attached. */
|
|
6612
|
+
wixelAssigned?: WixelAssigned;
|
|
6613
|
+
/** Emitted when Wixel is detached. */
|
|
6614
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6615
|
+
/** Emitted when StudioTwo is attached. */
|
|
6616
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6617
|
+
/** Emitted when StudioTwo is detached. */
|
|
6618
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6619
|
+
/** Emitted when media from user domain is enabled. */
|
|
6620
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6621
|
+
/** Emitted when media from user domain is disabled. */
|
|
6622
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6623
|
+
/** Emitted when Editorless is attached. */
|
|
6624
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6625
|
+
/** Emitted when Editorless is detached. */
|
|
6626
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6669
6627
|
/**
|
|
6670
|
-
*
|
|
6671
|
-
* @
|
|
6672
|
-
* @maxLength 100
|
|
6628
|
+
* A meta site id.
|
|
6629
|
+
* @format GUID
|
|
6673
6630
|
*/
|
|
6674
|
-
|
|
6631
|
+
metaSiteId?: string;
|
|
6632
|
+
/** A meta site version. Monotonically increasing. */
|
|
6633
|
+
version?: string;
|
|
6634
|
+
/** A timestamp of the event. */
|
|
6635
|
+
timestamp?: string;
|
|
6675
6636
|
/**
|
|
6676
|
-
*
|
|
6677
|
-
*
|
|
6678
|
-
* @
|
|
6679
|
-
* @targetRemovalDate 2026-11-01
|
|
6637
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
6638
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
6639
|
+
* @maxSize 4000
|
|
6680
6640
|
*/
|
|
6681
|
-
|
|
6682
|
-
|
|
6683
|
-
|
|
6641
|
+
assets?: Asset[];
|
|
6642
|
+
}
|
|
6643
|
+
/** @oneof */
|
|
6644
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
6645
|
+
/** Emitted on a meta site creation. */
|
|
6646
|
+
siteCreated?: SiteCreated;
|
|
6647
|
+
/** Emitted on a meta site transfer completion. */
|
|
6648
|
+
siteTransferred?: SiteTransferred;
|
|
6649
|
+
/** Emitted on a meta site deletion. */
|
|
6650
|
+
siteDeleted?: SiteDeleted;
|
|
6651
|
+
/** Emitted on a meta site restoration. */
|
|
6652
|
+
siteUndeleted?: SiteUndeleted;
|
|
6653
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
6654
|
+
sitePublished?: SitePublished;
|
|
6655
|
+
/** Emitted on a meta site unpublish. */
|
|
6656
|
+
siteUnpublished?: SiteUnpublished;
|
|
6657
|
+
/** Emitted when meta site is marked as template. */
|
|
6658
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
6659
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
6660
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
6661
|
+
/** Emitted when an application is provisioned (installed). */
|
|
6662
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
6663
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
6664
|
+
serviceRemoved?: ServiceRemoved;
|
|
6665
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
6666
|
+
siteRenamedPayload?: SiteRenamed;
|
|
6667
|
+
/** Emitted when meta site was permanently deleted. */
|
|
6668
|
+
hardDeleted?: SiteHardDeleted;
|
|
6669
|
+
/** Emitted on a namespace change. */
|
|
6670
|
+
namespaceChanged?: NamespaceChanged;
|
|
6671
|
+
/** Emitted when Studio is attached. */
|
|
6672
|
+
studioAssigned?: StudioAssigned;
|
|
6673
|
+
/** Emitted when Studio is detached. */
|
|
6674
|
+
studioUnassigned?: StudioUnassigned;
|
|
6684
6675
|
/**
|
|
6685
|
-
*
|
|
6686
|
-
*
|
|
6687
|
-
*
|
|
6676
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
6677
|
+
* the actual URL.
|
|
6678
|
+
*
|
|
6679
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
6680
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
6688
6681
|
*/
|
|
6689
|
-
|
|
6682
|
+
urlChanged?: SiteUrlChanged;
|
|
6683
|
+
/** Site is marked as PurgedExternally */
|
|
6684
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
6685
|
+
/** Emitted when Odeditor is attached. */
|
|
6686
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
6687
|
+
/** Emitted when Odeditor is detached. */
|
|
6688
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
6689
|
+
/** Emitted when Picasso is attached. */
|
|
6690
|
+
picassoAssigned?: PicassoAssigned;
|
|
6691
|
+
/** Emitted when Picasso is detached. */
|
|
6692
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
6693
|
+
/** Emitted when Wixel is attached. */
|
|
6694
|
+
wixelAssigned?: WixelAssigned;
|
|
6695
|
+
/** Emitted when Wixel is detached. */
|
|
6696
|
+
wixelUnassigned?: WixelUnassigned;
|
|
6697
|
+
/** Emitted when StudioTwo is attached. */
|
|
6698
|
+
studioTwoAssigned?: StudioTwoAssigned;
|
|
6699
|
+
/** Emitted when StudioTwo is detached. */
|
|
6700
|
+
studioTwoUnassigned?: StudioTwoUnassigned;
|
|
6701
|
+
/** Emitted when media from user domain is enabled. */
|
|
6702
|
+
userDomainMediaEnabled?: UserDomainMediaEnabled;
|
|
6703
|
+
/** Emitted when media from user domain is disabled. */
|
|
6704
|
+
userDomainMediaDisabled?: UserDomainMediaDisabled;
|
|
6705
|
+
/** Emitted when Editorless is attached. */
|
|
6706
|
+
editorlessAssigned?: EditorlessAssigned;
|
|
6707
|
+
/** Emitted when Editorless is detached. */
|
|
6708
|
+
editorlessUnassigned?: EditorlessUnassigned;
|
|
6709
|
+
}
|
|
6710
|
+
interface Asset {
|
|
6690
6711
|
/**
|
|
6691
|
-
*
|
|
6692
|
-
* @
|
|
6693
|
-
* @deprecated Whether the membership is voided.
|
|
6694
|
-
* @replacedBy payment.status
|
|
6695
|
-
* @targetRemovalDate 2026-11-01
|
|
6712
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
6713
|
+
* @maxLength 36
|
|
6696
6714
|
*/
|
|
6697
|
-
|
|
6715
|
+
appDefId?: string;
|
|
6698
6716
|
/**
|
|
6699
|
-
*
|
|
6700
|
-
* @
|
|
6717
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
6718
|
+
* @maxLength 200
|
|
6701
6719
|
*/
|
|
6702
|
-
|
|
6703
|
-
/**
|
|
6704
|
-
|
|
6720
|
+
instanceId?: string;
|
|
6721
|
+
/** An application state. */
|
|
6722
|
+
state?: StateWithLiterals;
|
|
6705
6723
|
}
|
|
6706
|
-
declare enum
|
|
6707
|
-
|
|
6708
|
-
|
|
6709
|
-
|
|
6710
|
-
|
|
6711
|
-
|
|
6712
|
-
CHARGE_PENDING = "CHARGE_PENDING",
|
|
6713
|
-
/** Payment was voided. */
|
|
6714
|
-
VOIDED = "VOIDED"
|
|
6724
|
+
declare enum State {
|
|
6725
|
+
UNKNOWN = "UNKNOWN",
|
|
6726
|
+
ENABLED = "ENABLED",
|
|
6727
|
+
DISABLED = "DISABLED",
|
|
6728
|
+
PENDING = "PENDING",
|
|
6729
|
+
DEMO = "DEMO"
|
|
6715
6730
|
}
|
|
6716
6731
|
/** @enumType */
|
|
6717
|
-
type
|
|
6718
|
-
interface
|
|
6732
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
6733
|
+
interface SiteCreated {
|
|
6719
6734
|
/**
|
|
6720
|
-
*
|
|
6721
|
-
* @
|
|
6735
|
+
* A template identifier (empty if not created from a template).
|
|
6736
|
+
* @maxLength 36
|
|
6722
6737
|
*/
|
|
6723
|
-
|
|
6738
|
+
originTemplateId?: string;
|
|
6724
6739
|
/**
|
|
6725
|
-
*
|
|
6726
|
-
* @
|
|
6740
|
+
* An account id of the owner.
|
|
6741
|
+
* @format GUID
|
|
6727
6742
|
*/
|
|
6728
|
-
|
|
6729
|
-
|
|
6730
|
-
|
|
6743
|
+
ownerId?: string;
|
|
6744
|
+
/** A context in which meta site was created. */
|
|
6745
|
+
context?: SiteCreatedContextWithLiterals;
|
|
6731
6746
|
/**
|
|
6732
|
-
*
|
|
6747
|
+
* A meta site id from which this site was created.
|
|
6748
|
+
*
|
|
6749
|
+
* In case of a creation from a template it's a template id.
|
|
6750
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
6733
6751
|
* @format GUID
|
|
6734
6752
|
*/
|
|
6735
|
-
|
|
6753
|
+
originMetaSiteId?: string | null;
|
|
6736
6754
|
/**
|
|
6737
|
-
*
|
|
6738
|
-
* @
|
|
6739
|
-
* @maxLength 40
|
|
6755
|
+
* A meta site name (URL slug).
|
|
6756
|
+
* @maxLength 20
|
|
6740
6757
|
*/
|
|
6741
|
-
|
|
6758
|
+
siteName?: string;
|
|
6759
|
+
/** A namespace. */
|
|
6760
|
+
namespace?: NamespaceWithLiterals;
|
|
6742
6761
|
}
|
|
6743
|
-
|
|
6744
|
-
/**
|
|
6745
|
-
|
|
6746
|
-
|
|
6747
|
-
|
|
6748
|
-
|
|
6762
|
+
declare enum SiteCreatedContext {
|
|
6763
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
6764
|
+
OTHER = "OTHER",
|
|
6765
|
+
/** A meta site was created from template. */
|
|
6766
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
6767
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
6768
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
6769
|
+
/** A copy of existing meta site. */
|
|
6770
|
+
DUPLICATE = "DUPLICATE",
|
|
6771
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
6772
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
6773
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
6774
|
+
FLASH = "FLASH"
|
|
6775
|
+
}
|
|
6776
|
+
/** @enumType */
|
|
6777
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
6778
|
+
declare enum Namespace {
|
|
6779
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
6780
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
6781
|
+
WIX = "WIX",
|
|
6782
|
+
/** 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. */
|
|
6783
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
6784
|
+
/** 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. */
|
|
6785
|
+
ALBUMS = "ALBUMS",
|
|
6786
|
+
/** 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. */
|
|
6787
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
6788
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6789
|
+
HOTELS = "HOTELS",
|
|
6790
|
+
/** 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. */
|
|
6791
|
+
CLUBS = "CLUBS",
|
|
6792
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6793
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
6749
6794
|
/**
|
|
6750
|
-
*
|
|
6751
|
-
*
|
|
6795
|
+
* AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6796
|
+
* Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
|
|
6752
6797
|
*/
|
|
6753
|
-
|
|
6798
|
+
DEV_SITE = "DEV_SITE",
|
|
6799
|
+
/** 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. */
|
|
6800
|
+
LOGOS = "LOGOS",
|
|
6801
|
+
/** 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. */
|
|
6802
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
6803
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6804
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
6805
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6806
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
6754
6807
|
/**
|
|
6755
|
-
*
|
|
6756
|
-
*
|
|
6757
|
-
*
|
|
6808
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
6809
|
+
*
|
|
6810
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
6758
6811
|
*/
|
|
6759
|
-
|
|
6760
|
-
}
|
|
6761
|
-
interface CashRoundingDetails {
|
|
6812
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
6762
6813
|
/**
|
|
6763
|
-
*
|
|
6764
|
-
*
|
|
6765
|
-
*
|
|
6814
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
6815
|
+
* Will be accessible from Site List and will not have a website app.
|
|
6816
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
6766
6817
|
*/
|
|
6767
|
-
|
|
6818
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
6819
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
6820
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
6821
|
+
/** It is to be used in the Business First efforts. */
|
|
6822
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
6823
|
+
/** Bookings business flow with no site. */
|
|
6824
|
+
ANYWHERE = "ANYWHERE",
|
|
6825
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
6826
|
+
HEADLESS = "HEADLESS",
|
|
6768
6827
|
/**
|
|
6769
|
-
*
|
|
6770
|
-
*
|
|
6771
|
-
* @readonly
|
|
6828
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
6829
|
+
* The site will be used for account level CSM feature for enterprise
|
|
6772
6830
|
*/
|
|
6773
|
-
|
|
6774
|
-
|
|
6775
|
-
|
|
6776
|
-
/** Payment was charged successfully. */
|
|
6777
|
-
APPROVED = "APPROVED",
|
|
6778
|
-
/** Payment is being processed and hasn't been confirmed yet. */
|
|
6779
|
-
PENDING = "PENDING",
|
|
6780
|
-
/** 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. */
|
|
6781
|
-
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
6782
|
-
/** Payment was canceled before it was charged. */
|
|
6783
|
-
CANCELED = "CANCELED",
|
|
6784
|
-
/** Payment was declined by the payment provider. */
|
|
6785
|
-
DECLINED = "DECLINED",
|
|
6786
|
-
/** Payment was fully refunded. */
|
|
6787
|
-
REFUNDED = "REFUNDED",
|
|
6788
|
-
/** Part of the payment amount was refunded. */
|
|
6789
|
-
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
6790
|
-
/** 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. */
|
|
6791
|
-
AUTHORIZED = "AUTHORIZED",
|
|
6831
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
6832
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
6833
|
+
RISE = "RISE",
|
|
6792
6834
|
/**
|
|
6793
|
-
*
|
|
6794
|
-
*
|
|
6795
|
-
*
|
|
6835
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
6836
|
+
* There's a blank site behind the scene but it's blank).
|
|
6837
|
+
* The Mobile company will be the owner of this namespace.
|
|
6796
6838
|
*/
|
|
6797
|
-
|
|
6798
|
-
|
|
6799
|
-
|
|
6800
|
-
type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
6801
|
-
interface CanceledStatusDetails {
|
|
6802
|
-
reason?: CanceledReasonWithLiterals;
|
|
6803
|
-
}
|
|
6804
|
-
declare enum CanceledReason {
|
|
6805
|
-
/** Other payment with the same chargeCorrelationId failed before current payment started. */
|
|
6806
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
|
|
6807
|
-
/** Payment was not completed by user and expired. */
|
|
6808
|
-
EXPIRED = "EXPIRED"
|
|
6809
|
-
}
|
|
6810
|
-
/** @enumType */
|
|
6811
|
-
type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
|
|
6812
|
-
interface DeclinedStatusDetails {
|
|
6813
|
-
reason?: DeclinedReasonWithLiterals;
|
|
6814
|
-
}
|
|
6815
|
-
declare enum DeclinedReason {
|
|
6816
|
-
/** Corresponding charge failed. */
|
|
6817
|
-
CHARGE_FAILED = "CHARGE_FAILED",
|
|
6818
|
-
/** Payment details expired. */
|
|
6819
|
-
EXPIRED = "EXPIRED",
|
|
6820
|
-
/** Insufficient funds. */
|
|
6821
|
-
INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
|
|
6822
|
-
/** Gift card was disabled before charge was attempted. */
|
|
6823
|
-
GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
|
|
6824
|
-
}
|
|
6825
|
-
/** @enumType */
|
|
6826
|
-
type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
|
|
6827
|
-
interface VoidedStatusDetails {
|
|
6828
|
-
reason?: VoidedReasonWithLiterals;
|
|
6829
|
-
}
|
|
6830
|
-
declare enum VoidedReason {
|
|
6831
|
-
/** Payment was voided by merchant request. */
|
|
6832
|
-
MERCHANT_REQUEST = "MERCHANT_REQUEST",
|
|
6833
|
-
/** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
|
|
6834
|
-
OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
|
|
6835
|
-
}
|
|
6836
|
-
/** @enumType */
|
|
6837
|
-
type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
|
|
6838
|
-
interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
|
|
6839
|
-
/** @internal */
|
|
6840
|
-
canceled?: CanceledStatusDetails;
|
|
6841
|
-
/** @internal */
|
|
6842
|
-
declined?: DeclinedStatusDetails;
|
|
6843
|
-
/** @internal */
|
|
6844
|
-
voided?: VoidedStatusDetails;
|
|
6839
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
6840
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
6841
|
+
NOWNIA = "NOWNIA",
|
|
6845
6842
|
/**
|
|
6846
|
-
*
|
|
6847
|
-
*
|
|
6848
|
-
* @minLength 1
|
|
6849
|
-
* @maxLength 10
|
|
6843
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
6844
|
+
* The Partners company owns this namespace.
|
|
6850
6845
|
*/
|
|
6851
|
-
|
|
6852
|
-
|
|
6853
|
-
|
|
6854
|
-
|
|
6855
|
-
|
|
6856
|
-
canceled?: CanceledStatusDetails;
|
|
6857
|
-
/** @internal */
|
|
6858
|
-
declined?: DeclinedStatusDetails;
|
|
6859
|
-
/** @internal */
|
|
6860
|
-
voided?: VoidedStatusDetails;
|
|
6861
|
-
}
|
|
6862
|
-
interface Refund {
|
|
6846
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
6847
|
+
/** Codux Headless Sites */
|
|
6848
|
+
CODUX = "CODUX",
|
|
6849
|
+
/** Bobb - AI Design Creator. */
|
|
6850
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
6863
6851
|
/**
|
|
6864
|
-
*
|
|
6865
|
-
*
|
|
6866
|
-
* @readonly
|
|
6852
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
6853
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
6867
6854
|
*/
|
|
6868
|
-
|
|
6855
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
6856
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6857
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
6858
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
6859
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
6860
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
6861
|
+
MIMIR = "MIMIR",
|
|
6862
|
+
/** Wix Twins platform. */
|
|
6863
|
+
TWINS = "TWINS",
|
|
6864
|
+
/** Wix Nano. */
|
|
6865
|
+
NANO = "NANO",
|
|
6866
|
+
/** Base44 headless sites. */
|
|
6867
|
+
BASE44 = "BASE44",
|
|
6868
|
+
/** Wix Channels Sites */
|
|
6869
|
+
CHANNELS = "CHANNELS",
|
|
6870
|
+
/** Nautilus platform. */
|
|
6871
|
+
NAUTILUS = "NAUTILUS",
|
|
6869
6872
|
/**
|
|
6870
|
-
*
|
|
6871
|
-
*
|
|
6873
|
+
* Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
|
|
6874
|
+
* Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
|
|
6872
6875
|
*/
|
|
6873
|
-
|
|
6874
|
-
/**
|
|
6875
|
-
|
|
6876
|
+
SYMPHONY = "SYMPHONY",
|
|
6877
|
+
/** Nautilus platform app. */
|
|
6878
|
+
NAUTILUS_APPS = "NAUTILUS_APPS",
|
|
6876
6879
|
/**
|
|
6877
|
-
*
|
|
6878
|
-
*
|
|
6879
|
-
* @immutable
|
|
6880
|
+
* Vibu — a siteless site representing a project built with Vibu (the AI app builder).
|
|
6881
|
+
* Holds the project's generated code, conversations, assets, and manages collaborators for the project.
|
|
6880
6882
|
*/
|
|
6881
|
-
|
|
6883
|
+
VIBU = "VIBU",
|
|
6882
6884
|
/**
|
|
6883
|
-
*
|
|
6884
|
-
*
|
|
6885
|
+
* Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
|
|
6886
|
+
* (an Enterprise account may have several), holding that BrandKit's brand definition
|
|
6887
|
+
* (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
|
|
6888
|
+
* MetaSites with this namespace will *not* be shown in a user's site list by default.
|
|
6885
6889
|
*/
|
|
6886
|
-
|
|
6890
|
+
ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
|
|
6887
6891
|
/**
|
|
6888
|
-
*
|
|
6889
|
-
*
|
|
6890
|
-
* @readonly
|
|
6891
|
-
* @immutable
|
|
6892
|
+
* Dev-center development sites (com.wixpress.devcenter.dsm).
|
|
6893
|
+
* DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
|
|
6892
6894
|
*/
|
|
6893
|
-
|
|
6895
|
+
DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
|
|
6894
6896
|
}
|
|
6895
|
-
|
|
6897
|
+
/** @enumType */
|
|
6898
|
+
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';
|
|
6899
|
+
/** Site transferred to another user. */
|
|
6900
|
+
interface SiteTransferred {
|
|
6896
6901
|
/**
|
|
6897
|
-
*
|
|
6902
|
+
* A previous owner id (user that transfers meta site).
|
|
6898
6903
|
* @format GUID
|
|
6899
|
-
* @immutable
|
|
6900
|
-
*/
|
|
6901
|
-
paymentId?: string;
|
|
6902
|
-
/**
|
|
6903
|
-
* Refund amount.
|
|
6904
|
-
* @immutable
|
|
6905
6904
|
*/
|
|
6906
|
-
|
|
6907
|
-
/** Refund status. */
|
|
6908
|
-
refundStatus?: RefundStatusWithLiterals;
|
|
6909
|
-
/** Optional details of current refund status. */
|
|
6910
|
-
refundStatusInfo?: RefundStatusInfo;
|
|
6905
|
+
oldOwnerId?: string;
|
|
6911
6906
|
/**
|
|
6912
|
-
*
|
|
6913
|
-
* This field is only returned when the value of `external_refund` is `false`.
|
|
6907
|
+
* A new owner id (user that accepts meta site).
|
|
6914
6908
|
* @format GUID
|
|
6915
6909
|
*/
|
|
6916
|
-
|
|
6917
|
-
|
|
6918
|
-
|
|
6910
|
+
newOwnerId?: string;
|
|
6911
|
+
}
|
|
6912
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
6913
|
+
interface SiteDeleted {
|
|
6914
|
+
/** A deletion context. */
|
|
6915
|
+
deleteContext?: DeleteContext;
|
|
6916
|
+
}
|
|
6917
|
+
interface DeleteContext {
|
|
6918
|
+
/** When the meta site was deleted. */
|
|
6919
|
+
dateDeleted?: Date | null;
|
|
6920
|
+
/** A status. */
|
|
6921
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
6919
6922
|
/**
|
|
6920
|
-
*
|
|
6921
|
-
* @
|
|
6923
|
+
* A reason (flow).
|
|
6924
|
+
* @maxLength 255
|
|
6922
6925
|
*/
|
|
6923
|
-
|
|
6926
|
+
deleteOrigin?: string;
|
|
6924
6927
|
/**
|
|
6925
|
-
*
|
|
6926
|
-
* @
|
|
6927
|
-
* @format GUID
|
|
6928
|
-
* @immutable
|
|
6928
|
+
* A service that deleted it.
|
|
6929
|
+
* @maxLength 255
|
|
6929
6930
|
*/
|
|
6930
|
-
|
|
6931
|
+
initiatorId?: string | null;
|
|
6931
6932
|
}
|
|
6932
|
-
|
|
6933
|
-
|
|
6934
|
-
|
|
6935
|
-
|
|
6936
|
-
|
|
6937
|
-
|
|
6938
|
-
/** Refund transaction failed. */
|
|
6939
|
-
FAILED = "FAILED",
|
|
6940
|
-
/** Refund request acknowledged, and will be executed soon. */
|
|
6941
|
-
SCHEDULED = "SCHEDULED",
|
|
6942
|
-
/** Refund was initiated on payment provider side. */
|
|
6943
|
-
STARTED = "STARTED"
|
|
6933
|
+
declare enum DeleteStatus {
|
|
6934
|
+
UNKNOWN = "UNKNOWN",
|
|
6935
|
+
TRASH = "TRASH",
|
|
6936
|
+
DELETED = "DELETED",
|
|
6937
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
6938
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
6944
6939
|
}
|
|
6945
6940
|
/** @enumType */
|
|
6946
|
-
type
|
|
6947
|
-
|
|
6948
|
-
|
|
6949
|
-
|
|
6950
|
-
|
|
6951
|
-
|
|
6952
|
-
|
|
6953
|
-
|
|
6954
|
-
*/
|
|
6955
|
-
paymentGatewayReasonCode?: string | null;
|
|
6941
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
6942
|
+
/** Restoration of the meta site. */
|
|
6943
|
+
interface SiteUndeleted {
|
|
6944
|
+
}
|
|
6945
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
6946
|
+
interface SitePublished {
|
|
6947
|
+
}
|
|
6948
|
+
interface SiteUnpublished {
|
|
6956
6949
|
/**
|
|
6957
|
-
*
|
|
6958
|
-
* @
|
|
6959
|
-
* @
|
|
6950
|
+
* A list of URLs previously associated with the meta site.
|
|
6951
|
+
* @maxLength 4000
|
|
6952
|
+
* @maxSize 10000
|
|
6960
6953
|
*/
|
|
6961
|
-
|
|
6954
|
+
urls?: string[];
|
|
6962
6955
|
}
|
|
6963
|
-
interface
|
|
6964
|
-
/** Total amount requested for refund. */
|
|
6965
|
-
requestedRefund?: Price;
|
|
6966
|
-
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
6967
|
-
pendingRefund?: Price;
|
|
6968
|
-
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
6969
|
-
refunded?: Price;
|
|
6970
|
-
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
6971
|
-
failedRefundAmount?: Price;
|
|
6972
|
-
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
6973
|
-
pending?: boolean;
|
|
6974
|
-
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
6975
|
-
breakdown?: RefundItemsBreakdown;
|
|
6956
|
+
interface SiteMarkedAsTemplate {
|
|
6976
6957
|
}
|
|
6977
|
-
interface
|
|
6958
|
+
interface SiteMarkedAsWixSite {
|
|
6959
|
+
}
|
|
6960
|
+
/**
|
|
6961
|
+
* Represents a service provisioned a site.
|
|
6962
|
+
*
|
|
6963
|
+
* Note on `origin_instance_id`:
|
|
6964
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
6965
|
+
* This is because of the following scenario:
|
|
6966
|
+
*
|
|
6967
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
6968
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
6969
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
6970
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
6971
|
+
* your site remains consistent with what you initially received and does not include any
|
|
6972
|
+
* changes made to the original template afterward.
|
|
6973
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
6974
|
+
*/
|
|
6975
|
+
interface ServiceProvisioned {
|
|
6978
6976
|
/**
|
|
6979
|
-
*
|
|
6980
|
-
* @
|
|
6977
|
+
* Either UUID or EmbeddedServiceType.
|
|
6978
|
+
* @maxLength 36
|
|
6981
6979
|
*/
|
|
6982
|
-
|
|
6983
|
-
}
|
|
6984
|
-
interface LineItemRefundSummary {
|
|
6980
|
+
appDefId?: string;
|
|
6985
6981
|
/**
|
|
6986
|
-
*
|
|
6987
|
-
* @
|
|
6982
|
+
* Not only UUID. Something here could be something weird.
|
|
6983
|
+
* @maxLength 36
|
|
6988
6984
|
*/
|
|
6989
|
-
|
|
6990
|
-
/** Total refunded amount for the line item. */
|
|
6991
|
-
totalRefundedAmount?: Price;
|
|
6992
|
-
}
|
|
6993
|
-
interface CalculateRefundRequest {
|
|
6985
|
+
instanceId?: string;
|
|
6994
6986
|
/**
|
|
6995
|
-
*
|
|
6996
|
-
* @
|
|
6997
|
-
* @maxLength 100
|
|
6987
|
+
* An instance id from which this instance is originated.
|
|
6988
|
+
* @maxLength 36
|
|
6998
6989
|
*/
|
|
6999
|
-
|
|
6990
|
+
originInstanceId?: string;
|
|
7000
6991
|
/**
|
|
7001
|
-
*
|
|
7002
|
-
* @
|
|
6992
|
+
* A version.
|
|
6993
|
+
* @maxLength 500
|
|
7003
6994
|
*/
|
|
7004
|
-
|
|
7005
|
-
/** Should include shipping in refund calculation */
|
|
7006
|
-
refundShipping?: boolean;
|
|
7007
|
-
}
|
|
7008
|
-
interface CalculateRefundItemRequest {
|
|
6995
|
+
version?: string | null;
|
|
7009
6996
|
/**
|
|
7010
|
-
*
|
|
6997
|
+
* The origin meta site id
|
|
7011
6998
|
* @format GUID
|
|
7012
6999
|
*/
|
|
7013
|
-
|
|
7000
|
+
originMetaSiteId?: string | null;
|
|
7001
|
+
}
|
|
7002
|
+
interface ServiceRemoved {
|
|
7014
7003
|
/**
|
|
7015
|
-
*
|
|
7016
|
-
* @
|
|
7017
|
-
* @max 100000
|
|
7004
|
+
* Either UUID or EmbeddedServiceType.
|
|
7005
|
+
* @maxLength 36
|
|
7018
7006
|
*/
|
|
7019
|
-
|
|
7020
|
-
}
|
|
7021
|
-
interface CalculateRefundResponse {
|
|
7022
|
-
/** Total refundable amount */
|
|
7023
|
-
total?: Price;
|
|
7024
|
-
/** Tax cost of the order */
|
|
7025
|
-
tax?: Price;
|
|
7026
|
-
/** Discount given for this order */
|
|
7027
|
-
discount?: Price;
|
|
7028
|
-
/** Total cost of the order (without tax) */
|
|
7029
|
-
subtotal?: Price;
|
|
7030
|
-
/** Total shipping cost for order */
|
|
7031
|
-
shipping?: Price;
|
|
7032
|
-
/** Previous refund given on that order */
|
|
7033
|
-
previouslyRefundedAmount?: Price;
|
|
7007
|
+
appDefId?: string;
|
|
7034
7008
|
/**
|
|
7035
|
-
*
|
|
7036
|
-
* @
|
|
7009
|
+
* Not only UUID. Something here could be something weird.
|
|
7010
|
+
* @maxLength 36
|
|
7037
7011
|
*/
|
|
7038
|
-
|
|
7039
|
-
}
|
|
7040
|
-
interface CalculateRefundItemResponse {
|
|
7012
|
+
instanceId?: string;
|
|
7041
7013
|
/**
|
|
7042
|
-
*
|
|
7043
|
-
* @
|
|
7014
|
+
* A version.
|
|
7015
|
+
* @maxLength 500
|
|
7044
7016
|
*/
|
|
7045
|
-
|
|
7046
|
-
/** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
|
|
7047
|
-
price?: Price;
|
|
7017
|
+
version?: string | null;
|
|
7048
7018
|
}
|
|
7049
|
-
|
|
7019
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
7020
|
+
interface SiteRenamed {
|
|
7050
7021
|
/**
|
|
7051
|
-
*
|
|
7052
|
-
* @
|
|
7053
|
-
* @maxLength 100
|
|
7022
|
+
* A new meta site name (URL slug).
|
|
7023
|
+
* @maxLength 20
|
|
7054
7024
|
*/
|
|
7055
|
-
|
|
7025
|
+
newSiteName?: string;
|
|
7056
7026
|
/**
|
|
7057
|
-
*
|
|
7058
|
-
* @
|
|
7059
|
-
* @maxSize 100
|
|
7060
|
-
* @format GUID
|
|
7027
|
+
* A previous meta site name (URL slug).
|
|
7028
|
+
* @maxLength 255
|
|
7061
7029
|
*/
|
|
7062
|
-
|
|
7030
|
+
oldSiteName?: string;
|
|
7063
7031
|
}
|
|
7064
|
-
|
|
7065
|
-
|
|
7066
|
-
|
|
7032
|
+
/**
|
|
7033
|
+
* Hard deletion of the meta site.
|
|
7034
|
+
*
|
|
7035
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
7036
|
+
*/
|
|
7037
|
+
interface SiteHardDeleted {
|
|
7038
|
+
/** A deletion context. */
|
|
7039
|
+
deleteContext?: DeleteContext;
|
|
7067
7040
|
}
|
|
7068
|
-
interface
|
|
7069
|
-
/**
|
|
7070
|
-
|
|
7071
|
-
|
|
7072
|
-
|
|
7073
|
-
|
|
7074
|
-
|
|
7041
|
+
interface NamespaceChanged {
|
|
7042
|
+
/** A previous namespace. */
|
|
7043
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
7044
|
+
/** A new namespace. */
|
|
7045
|
+
newNamespace?: NamespaceWithLiterals;
|
|
7046
|
+
}
|
|
7047
|
+
/** Assigned Studio editor */
|
|
7048
|
+
interface StudioAssigned {
|
|
7049
|
+
}
|
|
7050
|
+
/** Unassigned Studio editor */
|
|
7051
|
+
interface StudioUnassigned {
|
|
7052
|
+
}
|
|
7053
|
+
/**
|
|
7054
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
7055
|
+
*
|
|
7056
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
7057
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
7058
|
+
*
|
|
7059
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
7060
|
+
*/
|
|
7061
|
+
interface SiteUrlChanged {
|
|
7062
|
+
}
|
|
7063
|
+
/**
|
|
7064
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
7065
|
+
* Consumed by other teams to remove relevant data.
|
|
7066
|
+
*/
|
|
7067
|
+
interface SitePurgedExternally {
|
|
7075
7068
|
/**
|
|
7076
|
-
*
|
|
7077
|
-
* @minSize 1
|
|
7069
|
+
* @maxLength 2048
|
|
7078
7070
|
* @maxSize 100
|
|
7071
|
+
* @deprecated
|
|
7072
|
+
* @targetRemovalDate 2025-04-15
|
|
7079
7073
|
*/
|
|
7080
|
-
|
|
7074
|
+
appDefId?: string[];
|
|
7081
7075
|
}
|
|
7082
|
-
|
|
7083
|
-
|
|
7084
|
-
* Payment ID
|
|
7085
|
-
* @format GUID
|
|
7086
|
-
*/
|
|
7087
|
-
paymentId?: string | null;
|
|
7088
|
-
/**
|
|
7089
|
-
* Capture amount.
|
|
7090
|
-
* If not provided - full authorized amount will be captured.
|
|
7091
|
-
*/
|
|
7092
|
-
amount?: Price;
|
|
7076
|
+
/** Assigned Odeditor */
|
|
7077
|
+
interface OdeditorAssigned {
|
|
7093
7078
|
}
|
|
7094
|
-
|
|
7095
|
-
|
|
7096
|
-
orderTransactions?: OrderTransactions;
|
|
7079
|
+
/** Unassigned Odeditor */
|
|
7080
|
+
interface OdeditorUnassigned {
|
|
7097
7081
|
}
|
|
7098
|
-
|
|
7099
|
-
|
|
7100
|
-
* Ecom Order ID.
|
|
7101
|
-
* @minLength 1
|
|
7102
|
-
* @maxLength 100
|
|
7103
|
-
*/
|
|
7104
|
-
ecomOrderId?: string;
|
|
7105
|
-
/** Amount to be charged */
|
|
7106
|
-
amount?: Price;
|
|
7082
|
+
/** Assigned Picasso editor */
|
|
7083
|
+
interface PicassoAssigned {
|
|
7107
7084
|
}
|
|
7108
|
-
|
|
7109
|
-
|
|
7110
|
-
paymentGatewayOrderId?: string;
|
|
7085
|
+
/** Unassigned Picasso */
|
|
7086
|
+
interface PicassoUnassigned {
|
|
7111
7087
|
}
|
|
7112
|
-
|
|
7113
|
-
|
|
7114
|
-
metasiteId?: string;
|
|
7115
|
-
/**
|
|
7116
|
-
* @minLength 1
|
|
7117
|
-
* @maxLength 100
|
|
7118
|
-
* @maxSize 100
|
|
7119
|
-
*/
|
|
7120
|
-
orderIds?: string[];
|
|
7088
|
+
/** Assigned Wixel */
|
|
7089
|
+
interface WixelAssigned {
|
|
7121
7090
|
}
|
|
7122
|
-
|
|
7091
|
+
/** Unassigned Wixel */
|
|
7092
|
+
interface WixelUnassigned {
|
|
7123
7093
|
}
|
|
7124
|
-
|
|
7125
|
-
|
|
7126
|
-
|
|
7127
|
-
|
|
7128
|
-
|
|
7129
|
-
|
|
7130
|
-
|
|
7131
|
-
|
|
7094
|
+
/** Assigned StudioTwo */
|
|
7095
|
+
interface StudioTwoAssigned {
|
|
7096
|
+
}
|
|
7097
|
+
/** Unassigned StudioTwo */
|
|
7098
|
+
interface StudioTwoUnassigned {
|
|
7099
|
+
}
|
|
7100
|
+
/** Media from user domain is enabled. */
|
|
7101
|
+
interface UserDomainMediaEnabled {
|
|
7102
|
+
}
|
|
7103
|
+
/** Media from user domain is disabled. */
|
|
7104
|
+
interface UserDomainMediaDisabled {
|
|
7105
|
+
}
|
|
7106
|
+
/** Assigned Editorless */
|
|
7107
|
+
interface EditorlessAssigned {
|
|
7108
|
+
}
|
|
7109
|
+
/** Unassigned Editorless */
|
|
7110
|
+
interface EditorlessUnassigned {
|
|
7111
|
+
}
|
|
7112
|
+
interface HasCustomEmailConfigurationsRequest {
|
|
7113
|
+
}
|
|
7114
|
+
interface HasCustomEmailConfigurationsResponse {
|
|
7115
|
+
hasCustomConfigurations?: boolean;
|
|
7116
|
+
}
|
|
7117
|
+
interface AddToAutomationMigrationPopulationRequest {
|
|
7118
|
+
/** When true, sends custom email configurations to automation system via email */
|
|
7119
|
+
sendCustomEmailConfigs?: boolean;
|
|
7120
|
+
/** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
|
|
7121
|
+
origin?: OriginWithLiterals;
|
|
7122
|
+
}
|
|
7123
|
+
declare enum Origin {
|
|
7124
|
+
OPT_IN = "OPT_IN",
|
|
7125
|
+
MIGRATION = "MIGRATION"
|
|
7126
|
+
}
|
|
7127
|
+
/** @enumType */
|
|
7128
|
+
type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
|
|
7129
|
+
interface AddToAutomationMigrationPopulationResponse {
|
|
7130
|
+
success?: boolean;
|
|
7131
|
+
}
|
|
7132
|
+
interface IsInAutomationMigrationPopulationRequest {
|
|
7133
|
+
}
|
|
7134
|
+
interface IsInAutomationMigrationPopulationResponse {
|
|
7135
|
+
inPopulation?: boolean;
|
|
7132
7136
|
}
|
|
7133
7137
|
interface DiffmatokyPayload {
|
|
7134
7138
|
left?: string;
|
|
@@ -10972,4 +10976,4 @@ interface BulkUpdateOrderTagsOptions {
|
|
|
10972
10976
|
unassignTags?: TagsTags;
|
|
10973
10977
|
}
|
|
10974
10978
|
|
|
10975
|
-
export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, PredefinedPaymentMethod as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountValueType as aD, DiscountReason as aE, LineItemQuantityChangeType as aF, ActivityType as aG, OrderActivityTypeEnumActivityType as aH, AttributionSource as aI, ChannelType as aJ, AdditionalFeeSource as aK, OrderActionType as aL, SpecificItemsCouponBehavior as aM, ChargeType as aN, VersioningMode as aO, DeltaPaymentOptionType as aP, InventoryAction as aQ, WebhookIdentityType as aR, PreviewEmailType as aS, State as aT, SiteCreatedContext as aU, Namespace as aV, DeleteStatus as aW, Origin as aX, ScheduledAction as aY, DurationUnit as aZ, PaymentCollectabilityStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type ServiceProperties as b$, RefundableStatus as b0, NonRefundableReason as b1, ManuallyRefundableReason as b2, RestockType as b3, TransactionStatus as b4, AuthorizationCaptureStatus as b5, AuthorizationVoidStatus as b6, Reason as b7, ActionType as b8, ChargebackStatus as b9, type Dimensions as bA, type ItemType as bB, type ItemTypeItemTypeDataOneOf as bC, type RestockLocation as bD, type ItemTaxFullDetails as bE, type LineItemTaxInfo as bF, type LineItemTaxBreakdown as bG, type DigitalFile as bH, type SubscriptionInfo as bI, type SubscriptionTitle as bJ, type SubscriptionDescription as bK, type SubscriptionSettings as bL, type FreeTrialPeriod as bM, type BillingSettings as bN, type BillingAdjustment as bO, type BillingAdjustmentPriceSummary as bP, type CyclePriceOverride as bQ, type PriceDescription as bR, type LocationAndQuantity as bS, type TaxableAddress as bT, type TaxableAddressTaxableAddressDataOneOf as bU, type DecimalQuantity as bV, type DecimalQuantityUnitOneOf as bW, type TranslatableString as bX, type ExtendedFields as bY, type ModifierGroup as bZ, type ItemModifier as b_, MembershipPaymentStatus as ba, PaymentStatus as bb, CanceledReason as bc, DeclinedReason as bd, VoidedReason as be, RefundStatus as bf, SortOrder as bg, OrderApprovalStrategy as bh, Placement as bi, SubdivisionType as bj, SourceType as bk, CustomFieldGroup as bl, ValueType as bm, DepositType as bn, InvoiceStatus as bo, type OrderLineItem as bp, type ProductName as bq, type CatalogReference as br, type DescriptionLine as bs, type DescriptionLineValueOneOf as bt, type DescriptionLineDescriptionLineValueOneOf as bu, type DescriptionLineName as bv, type PlainTextValue as bw, type Color as bx, type FocalPoint as by, type PhysicalProperties as bz, type SetOrderNumberCounterApplicationErrors as c, type AuthorizedPaymentCreated as c$, type CrossBorderPriceAdjustment as c0, type BuyerInfo as c1, type BuyerInfoIdOneOf as c2, type CurrencyConversionDetails as c3, type CrossBorderRepricing as c4, type PriceSummary as c5, type AddressWithContact as c6, type Address as c7, type StreetAddress as c8, type AddressLocation as c9, type Activity as cA, type ActivityContentOneOf as cB, type CustomActivity as cC, type MerchantComment as cD, type OrderRefunded as cE, type OrderCreatedFromExchange as cF, type NewExchangeOrderCreated as cG, type LineItemExchangeData as cH, type DraftOrderChangesApplied as cI, type OrderChange as cJ, type OrderChangeValueOneOf as cK, type LineItemChanges as cL, type LineItemQuantityChange as cM, type LineItemPriceChange as cN, type LineItemProductNameChange as cO, type LineItemDescriptionLineChange as cP, type LineItemModifiersChange as cQ, type ManagedLineItem as cR, type ManagedDiscount as cS, type TranslatedValue as cT, type LineItemAmount as cU, type ManagedAdditionalFee as cV, type TotalPriceChange as cW, type ShippingInformationChange as cX, type ShippingInformation as cY, type PricesRecalculatedForDestination as cZ, type SavedPaymentMethod as c_, type FullAddressContactDetails as ca, type VatId as cb, type V1ShippingInformation as cc, type DeliveryLogistics as cd, type DeliveryLogisticsAddressOneOf as ce, type PickupDetails as cf, type PickupAddress as cg, type DeliveryTimeSlot as ch, type ShippingPrice as ci, type ShippingRegion as cj, type TaxSummary as ck, type OrderTaxInfo as cl, type OrderTaxBreakdown as cm, type CrossBorderCalculation as cn, type AppliedDiscount as co, type AppliedDiscountDiscountSourceOneOf as cp, type Coupon as cq, type CouponDiscountValueOneOf as cr, type MerchantDiscount as cs, type MerchantDiscountMerchantDiscountReasonOneOf as ct, type DiscountRule as cu, type DiscountRuleDiscountValueOneOf as cv, type DiscountRuleName as cw, type LineItemDiscount as cx, type ItemCombination as cy, type ItemCombinationLineItem as cz, type PreparePaymentCollectionOptions as d, type OrderRejectedEventOrderRejected as d$, type AuthorizedPaymentCaptured as d0, type AuthorizedPaymentVoided as d1, type RefundInitiated as d2, type RefundedPayment as d3, type RefundedPaymentKindOneOf as d4, type RegularPaymentRefund as d5, type GiftCardPaymentRefund as d6, type MembershipPaymentRefund as d7, type PaymentRefunded as d8, type PaymentRefundFailed as d9, type AdditionalFee as dA, type FulfillmentStatusesAggregate as dB, type Tags as dC, type TagList as dD, type Location as dE, type OrderSettings as dF, type OrderSettingsAllowedActionsOneOf as dG, type OrderSettingsEditableByOneOf as dH, type CustomAllowedActions as dI, type OwnerApps as dJ, type FormInfo as dK, type FormIdentifier as dL, type PlatformFeeSummary as dM, type PlatformFee as dN, type UpdateInternalDocumentsEvent as dO, type UpdateInternalDocumentsEventOperationOneOf as dP, type InternalDocument as dQ, type InternalDocumentUpdateOperation as dR, type DeleteByIdsOperation as dS, type DeleteByFilterOperation as dT, type InternalDocumentUpdateByFilterOperation as dU, type InternalUpdateExistingOperation as dV, type VersionedDocumentUpdateOperation as dW, type VersionedDeleteByIdsOperation as dX, type VersionedDocumentId as dY, type OrderApproved as dZ, type OrdersExperiments as d_, type RefundedAsStoreCredit as da, type PaymentPending as db, type PaymentPendingPaymentDetailsOneOf as dc, type RegularPayment as dd, type RegularPaymentPaymentMethodDetailsOneOf as de, type CreditCardDetails as df, type PaymentCanceled as dg, type PaymentCanceledPaymentDetailsOneOf as dh, type PaymentDeclined as di, type PaymentDeclinedPaymentDetailsOneOf as dj, type ReceiptCreated as dk, type ReceiptCreatedReceiptInfoOneOf as dl, type WixReceipt as dm, type ExternalReceipt as dn, type ReceiptSent as dp, type ReceiptSentReceiptInfoOneOf as dq, type ChargebackCreated as dr, type ChargebackReversed as ds, type CreatedBy as dt, type CreatedByStringOneOf as du, type ChannelInfo as dv, type CustomField as dw, type BalanceSummary as dx, type Balance as dy, type CashRounding as dz, type PreparePaymentCollectionResponse as e, type PreviewEmailByTypeResponse as e$, type OrderItemsRestocked as e0, type V1RestockItem as e1, type OrderImported as e2, type ImportedOrderDeleted as e3, type PaymentStatusUpdated as e4, type FulfillmentStatusUpdated as e5, type OrderCanceledEventOrderCanceled as e6, type OrderDeltasCommitted as e7, type CommittedDiffs as e8, type CommittedDiffsShippingUpdateInfoOneOf as e9, type AccountInfo as eA, type ImportOrderRequest as eB, type SetOrderNumberCounterRequest as eC, type BulkDeleteImportedOrdersRequest as eD, type SendBuyerConfirmationEmailRequest as eE, type SendBuyerConfirmationEmailResponse as eF, type SendBuyerPaymentsReceivedEmailRequest as eG, type SendBuyerPaymentsReceivedEmailResponse as eH, type SendBuyerPickupConfirmationEmailRequest as eI, type SendBuyerPickupConfirmationEmailResponse as eJ, type BulkSendBuyerPickupConfirmationEmailsRequest as eK, type BulkSendBuyerPickupConfirmationEmailsResponse as eL, type SendBuyerShippingConfirmationEmailRequest as eM, type SendBuyerShippingConfirmationEmailResponse as eN, type BulkSendBuyerShippingConfirmationEmailsRequest as eO, type BulkSendBuyerShippingConfirmationEmailsResponse as eP, type SendMerchantOrderReceivedNotificationRequest as eQ, type SendMerchantOrderReceivedNotificationResponse as eR, type SendCancelRefundEmailRequest as eS, type SendCancelRefundEmailResponse as eT, type SendRefundEmailRequest as eU, type SendRefundEmailResponse as eV, type SendFulfillmentEmailRequest as eW, type SendFulfillmentEmailResponse as eX, type SendMerchantOrderReceivedPushRequest as eY, type SendMerchantOrderReceivedPushResponse as eZ, type PreviewEmailByTypeRequest as e_, type ItemChangedDetails as ea, type OrderLineItemChangedDetails as eb, type DecimalQuantityUpdate as ec, type CrossBorderAdjustmentUpdate as ed, type LineItemDelta as ee, type LineItemDeltaDeltaOneOf as ef, type AppliedDiscountDelta as eg, type AppliedDiscountDeltaDeltaOneOf as eh, type AdditionalFeeDelta as ei, type AdditionalFeeDeltaDeltaOneOf as ej, type DraftOrderCommitSettings as ek, type InventoryUpdateDetails as el, type TriggerReindexRequest as em, type TriggerReindexResponse as en, type DomainEvent as eo, type DomainEventBodyOneOf as ep, type EntityCreatedEvent as eq, type RestoreInfo as er, type EntityUpdatedEvent as es, type EntityDeletedEvent as et, type ActionEvent as eu, type Empty as ev, type TriggerReindexOrderRequest as ew, type MessageEnvelope as ex, type IdentificationData as ey, type IdentificationDataIdOneOf as ez, type PreparePaymentCollectionApplicationErrors as f, type Duration as f$, type PreviewRefundEmailRequest as f0, type RefundDetails as f1, type RefundItem as f2, type LineItemRefund as f3, type AdditionalFeeRefund as f4, type ShippingRefund as f5, type PreviewRefundEmailResponse as f6, type PreviewCancelEmailRequest as f7, type PreviewCancelEmailResponse as f8, type PreviewCancelRefundEmailRequest as f9, type SiteHardDeleted as fA, type NamespaceChanged as fB, type StudioAssigned as fC, type StudioUnassigned as fD, type SiteUrlChanged as fE, type SitePurgedExternally as fF, type OdeditorAssigned as fG, type OdeditorUnassigned as fH, type PicassoAssigned as fI, type PicassoUnassigned as fJ, type WixelAssigned as fK, type WixelUnassigned as fL, type StudioTwoAssigned as fM, type StudioTwoUnassigned as fN, type UserDomainMediaEnabled as fO, type UserDomainMediaDisabled as fP, type EditorlessAssigned as fQ, type EditorlessUnassigned as fR, type HasCustomEmailConfigurationsRequest as fS, type HasCustomEmailConfigurationsResponse as fT, type AddToAutomationMigrationPopulationRequest as fU, type AddToAutomationMigrationPopulationResponse as fV, type IsInAutomationMigrationPopulationRequest as fW, type IsInAutomationMigrationPopulationResponse as fX, type PreparePaymentCollectionRequest as fY, type RedirectUrls as fZ, type DelayedCaptureSettings as f_, type PreviewCancelRefundEmailResponse as fa, type PreviewBuyerPaymentsReceivedEmailRequest as fb, type PreviewBuyerPaymentsReceivedEmailResponse as fc, type PreviewBuyerConfirmationEmailRequest as fd, type PreviewBuyerConfirmationEmailResponse as fe, type PreviewBuyerPickupConfirmationEmailRequest as ff, type PreviewBuyerPickupConfirmationEmailResponse as fg, type PreviewShippingConfirmationEmailRequest as fh, type PreviewShippingConfirmationEmailResponse as fi, type PreviewResendDownloadLinksEmailRequest as fj, type PreviewResendDownloadLinksEmailResponse as fk, type MetaSiteSpecialEvent as fl, type MetaSiteSpecialEventPayloadOneOf as fm, type Asset as fn, type SiteCreated as fo, type SiteTransferred as fp, type SiteDeleted as fq, type DeleteContext as fr, type SiteUndeleted as fs, type SitePublished as ft, type SiteUnpublished as fu, type SiteMarkedAsTemplate as fv, type SiteMarkedAsWixSite as fw, type ServiceProvisioned as fx, type ServiceRemoved as fy, type SiteRenamed as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type ChargeSavedPaymentMethodResponse as g$, type GetPaymentCollectabilityStatusRequest as g0, type RecordManuallyCollectedPaymentRequest as g1, type UserDefinedPaymentMethodName as g2, type UserDefinedPaymentMethodNameKindOneOf as g3, type RecordManuallyCollectedPaymentResponse as g4, type MarkOrderAsPaidRequest as g5, type BulkMarkOrdersAsPaidRequest as g6, type BulkOrderResult as g7, type ItemMetadata as g8, type ApplicationError as g9, type V1ScheduledAction as gA, type Chargeback as gB, type PaymentMethodName as gC, type GiftCardPaymentDetails as gD, type MembershipPaymentDetails as gE, type FutureMembershipDetails as gF, type WixReceiptInfo as gG, type ExternalReceiptInfo as gH, type CashRoundingDetails as gI, type CanceledStatusDetails as gJ, type DeclinedStatusDetails as gK, type VoidedStatusDetails as gL, type PaymentStatusDetails as gM, type PaymentStatusDetailsStatusDetailsOneOf as gN, type Refund as gO, type RefundTransaction as gP, type RefundStatusInfo as gQ, type AggregatedRefundSummary as gR, type RefundItemsBreakdown as gS, type LineItemRefundSummary as gT, type CalculateRefundRequest as gU, type CalculateRefundItemRequest as gV, type CalculateRefundResponse as gW, type CalculateRefundItemResponse as gX, type VoidAuthorizedPaymentsRequest as gY, type CaptureAuthorizedPaymentsRequest as gZ, type ChargeSavedPaymentMethodRequest as g_, type BulkActionMetadata as ga, type GetRefundabilityStatusRequest as gb, type Refundability as gc, type RefundabilityAdditionalRefundabilityInfoOneOf as gd, type CreatePaymentGatewayOrderRequest as ge, type ChargedBy as gf, type ChargeMembershipsRequest as gg, type MembershipChargeItem as gh, type MembershipName as gi, type ChargeMembershipsResponse as gj, type TriggerRefundRequest as gk, type RefundSideEffects as gl, type RestockInfo as gm, type RestockItem as gn, type OrderTransactions as go, type Payment as gp, type PaymentPaymentDetailsOneOf as gq, type PaymentReceiptInfoOneOf as gr, type PaymentStatusDetailsOneOf as gs, type RegularPaymentDetails as gt, type RegularPaymentDetailsPaymentMethodDetailsOneOf as gu, type CreditCardPaymentMethodDetails as gv, type AuthorizationDetails as gw, type AuthorizationCapture as gx, type AuthorizationActionFailureDetails as gy, type AuthorizationVoid as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type UpdateOrderLineItemsResponse as h$, type V1TriggerReindexRequest as h0, type V1TriggerReindexResponse as h1, type V1TriggerReindexOrderRequest as h2, type DiffmatokyPayload as h3, type ErrorInformation as h4, type GetOrderRequest as h5, type GetOrderResponse as h6, type InternalQueryOrdersRequest as h7, type PlatformQuery as h8, type PlatformQueryPagingMethodOneOf as h9, type V1LineItemDelta as hA, type V1LineItemDeltaDeltaOneOf as hB, type CommitDeltasResponse as hC, type ArchiveOrderRequest as hD, type ArchiveOrderResponse as hE, type BulkArchiveOrdersRequest as hF, type BulkArchiveOrdersResponse as hG, type BulkArchiveOrdersByFilterRequest as hH, type BulkArchiveOrdersByFilterResponse as hI, type UnArchiveOrderRequest as hJ, type UnArchiveOrderResponse as hK, type BulkUnArchiveOrdersRequest as hL, type BulkUnArchiveOrdersResponse as hM, type BulkUnArchiveOrdersByFilterRequest as hN, type BulkUnArchiveOrdersByFilterResponse as hO, type UpdateBuyerInfoRequest as hP, type BuyerInfoUpdate as hQ, type UpdateBuyerInfoResponse as hR, type UpdateBuyerEmailRequest as hS, type UpdateBuyerEmailResponse as hT, type UpdateOrderShippingAddressRequest as hU, type UpdateOrderShippingAddressResponse as hV, type UpdateBillingContactDetailsRequest as hW, type UpdateBillingContactDetailsResponse as hX, type UpdateOrderLineItemRequest as hY, type UpdateOrderLineItemsRequest as hZ, type MaskedOrderLineItem as h_, type Sorting as ha, type PlatformPaging as hb, type CursorPaging as hc, type InternalQueryOrdersResponse as hd, type PlatformPagingMetadata as he, type Cursors as hf, type QueryOrderRequest as hg, type QueryOrderResponse as hh, type SearchOrdersRequest as hi, type CursorSearch as hj, type CursorSearchPagingMethodOneOf as hk, type CursorPagingMetadata as hl, type CreateOrderRequest as hm, type OrderCreationSettings as hn, type OrderCreationSettingsEditableByOneOf as ho, type OrderCreateNotifications as hp, type CreateOrderResponse as hq, type UpdateOrderRequest as hr, type UpdateOrderResponse as hs, type BulkUpdateOrdersRequest as ht, type CommitDeltasRequest as hu, type DraftOrderDiffs as hv, type DraftOrderDiffsShippingUpdateInfoOneOf as hw, type DraftOrderDiffsBuyerUpdateInfoOneOf as hx, type DraftOrderDiffsBillingUpdateInfoOneOf as hy, type DraftOrderDiffsRecipientUpdateInfoOneOf as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type DecrementItemsQuantityResponse as i$, type AddInternalActivityRequest as i0, type InternalActivity as i1, type InternalActivityContentOneOf as i2, type OrderPlaced as i3, type OrderPaid as i4, type OrderFulfilled as i5, type OrderNotFulfilled as i6, type OrderCanceled as i7, type DownloadLinkSent as i8, type TrackingNumberAdded as i9, type UpdateOrderStatusRequest as iA, type MarkAsFulfilledRequest as iB, type MarkAsFulfilledResponse as iC, type BulkMarkAsFulfilledRequest as iD, type BulkMarkAsFulfilledResponse as iE, type BulkMarkAsFulfilledByFilterRequest as iF, type BulkMarkAsFulfilledByFilterResponse as iG, type MarkAsUnfulfilledRequest as iH, type MarkAsUnfulfilledResponse as iI, type BulkMarkAsUnfulfilledRequest as iJ, type BulkMarkAsUnfulfilledResponse as iK, type BulkMarkAsUnfulfilledByFilterRequest as iL, type BulkMarkAsUnfulfilledByFilterResponse as iM, type BulkSetBusinessLocationRequest as iN, type BulkSetBusinessLocationResponse as iO, type BulkSetBusinessLocationResult as iP, type V1MarkOrderAsPaidRequest as iQ, type V1MarkOrderAsPaidResponse as iR, type V1BulkMarkOrdersAsPaidRequest as iS, type V1BulkMarkOrdersAsPaidResponse as iT, type V1CreatePaymentGatewayOrderRequest as iU, type V1CreatePaymentGatewayOrderResponse as iV, type GetShipmentsRequest as iW, type GetShipmentsResponse as iX, type AggregateOrdersRequest as iY, type DecrementItemsQuantityRequest as iZ, type DecrementData as i_, type TrackingNumberEdited as ia, type TrackingLinkAdded as ib, type ShippingConfirmationEmailSent as ic, type InvoiceAdded as id, type InvoiceSent as ie, type FulfillerEmailSent as ig, type ShippingAddressEdited as ih, type EmailEdited as ii, type PickupReadyEmailSent as ij, type OrderPartiallyPaid as ik, type OrderPending as il, type OrderRejected as im, type AddInternalActivityResponse as io, type AddActivityRequest as ip, type PublicActivityContentOneOf as iq, type AddActivitiesRequest as ir, type UpdateActivityRequest as is, type DeleteActivityRequest as it, type UpdateLineItemsDescriptionLinesRequest as iu, type LineItemUpdate as iv, type UpdateLineItemsDescriptionLinesResponse as iw, type MarkOrderAsSeenByHumanRequest as ix, type MarkOrderAsSeenByHumanResponse as iy, type CancelOrderRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type RepriceStatusWithLiterals as j$, type BulkUpdateOrderTagsRequest as j0, type TagsTags as j1, type TagsTagList as j2, type BulkUpdateOrderTagsResult as j3, type SendOrderUpdatedDomainEventRequest as j4, type SendOrderUpdatedDomainEventResponse as j5, type Task as j6, type TaskKey as j7, type TaskAction as j8, type TaskActionActionOneOf as j9, type ItemizedFee as jA, type Discount as jB, type DiscountOneDiscountTypeOneOf as jC, type CalculatedTaxes as jD, type CalculatedTax as jE, type Payments as jF, type InvoicesPayment as jG, type MetaData as jH, type InvoiceDynamicPriceTotals as jI, type CustomFieldValue as jJ, type Value as jK, type Deposit as jL, type BaseEventMetadata as jM, type EventMetadata as jN, type AccountInfoMetadata as jO, type OrderSearchSpec as jP, utils as jQ, type DescriptionLineTypeWithLiterals as jR, type DimensionsUnitWithLiterals as jS, type ItemTypePresetWithLiterals as jT, type PaymentOptionTypeWithLiterals as jU, type JurisdictionTypeWithLiterals as jV, type SubscriptionFrequencyWithLiterals as jW, type ProductPeriodAlignmentWithLiterals as jX, type AdjustmentTypeWithLiterals as jY, type TaxableAddressTypeWithLiterals as jZ, type MeasurementUnitWithLiterals as j_, type Complete as ja, type Cancel as jb, type Reschedule as jc, type InvoiceSentEvent as jd, type IdAndVersion as je, type InvoiceFields as jf, type Customer as jg, type Email as jh, type QuotesAddress as ji, type AddressDescription as jj, type Phone as jk, type Company as jl, type CommonAddress as jm, type CommonAddressStreetOneOf as jn, type Subdivision as jo, type StandardDetails as jp, type ShippingContactDetails as jq, type InvoiceDates as jr, type LineItems as js, type LineItem as jt, type BigDecimalWrapper as ju, type LineItemTax as jv, type Source as jw, type LineItemMetaData as jx, type Locale as jy, type TotalPrice as jz, type GetRefundabilityStatusResponse as k, onOrderCreated as k$, type BaseRateSourceWithLiterals as k0, type PaymentStatusEnumPaymentStatusWithLiterals as k1, type FulfillmentStatusWithLiterals as k2, type WeightUnitWithLiterals as k3, type VatTypeWithLiterals as k4, type PickupMethodWithLiterals as k5, type CrossBorderNotApplicableReasonWithLiterals as k6, type CrossBorderRepricingModeWithLiterals as k7, type DiscountTypeWithLiterals as k8, type DiscountValueTypeWithLiterals as k9, type ManuallyRefundableReasonWithLiterals as kA, type RestockTypeWithLiterals as kB, type TransactionStatusWithLiterals as kC, type AuthorizationCaptureStatusWithLiterals as kD, type AuthorizationVoidStatusWithLiterals as kE, type ReasonWithLiterals as kF, type ActionTypeWithLiterals as kG, type ChargebackStatusWithLiterals as kH, type MembershipPaymentStatusWithLiterals as kI, type PaymentStatusWithLiterals as kJ, type CanceledReasonWithLiterals as kK, type DeclinedReasonWithLiterals as kL, type VoidedReasonWithLiterals as kM, type RefundStatusWithLiterals as kN, type SortOrderWithLiterals as kO, type OrderApprovalStrategyWithLiterals as kP, type PlacementWithLiterals as kQ, type SubdivisionTypeWithLiterals as kR, type SourceTypeWithLiterals as kS, type CustomFieldGroupWithLiterals as kT, type ValueTypeWithLiterals as kU, type DepositTypeWithLiterals as kV, type InvoiceStatusWithLiterals as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type DiscountReasonWithLiterals as ka, type LineItemQuantityChangeTypeWithLiterals as kb, type ActivityTypeWithLiterals as kc, type OrderActivityTypeEnumActivityTypeWithLiterals as kd, type AttributionSourceWithLiterals as ke, type ChannelTypeWithLiterals as kf, type AdditionalFeeSourceWithLiterals as kg, type OrderActionTypeWithLiterals as kh, type SpecificItemsCouponBehaviorWithLiterals as ki, type ChargeTypeWithLiterals as kj, type VersioningModeWithLiterals as kk, type DeltaPaymentOptionTypeWithLiterals as kl, type InventoryActionWithLiterals as km, type WebhookIdentityTypeWithLiterals as kn, type PreviewEmailTypeWithLiterals as ko, type StateWithLiterals as kp, type SiteCreatedContextWithLiterals as kq, type NamespaceWithLiterals as kr, type DeleteStatusWithLiterals as ks, type OriginWithLiterals as kt, type ScheduledActionWithLiterals as ku, type DurationUnitWithLiterals as kv, type PaymentCollectabilityStatusWithLiterals as kw, type PredefinedPaymentMethodWithLiterals as kx, type RefundableStatusWithLiterals as ky, type NonRefundableReasonWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, onOrderFulfilled as l0, onOrderImported as l1, onOrderImportedOrderDeleted as l2, onOrderPaymentStatusUpdated as l3, onOrderUpdated as l4, importOrder as l5, setOrderNumberCounter as l6, bulkDeleteImportedOrders as l7, preparePaymentCollection as l8, getPaymentCollectabilityStatus as l9, recordManuallyCollectedPayment as la, paymentCollectionMarkOrderAsPaid as lb, paymentCollectionBulkMarkOrdersAsPaid as lc, getRefundabilityStatus as ld, paymentCollectionCreatePaymentGatewayOrder as le, chargeMemberships as lf, triggerRefund as lg, voidAuthorizedPayments as lh, captureAuthorizedPayments as li, getOrder as lj, createOrder as lk, updateOrder as ll, bulkUpdateOrders as lm, updateOrderLineItem as ln, addActivity as lo, addActivities as lp, updateActivity as lq, deleteActivity as lr, cancelOrder as ls, updateOrderStatus as lt, aggregateOrders as lu, bulkUpdateOrderTags as lv, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
|
|
10979
|
+
export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, AuthorizationCaptureStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountValueType as aD, DiscountReason as aE, LineItemQuantityChangeType as aF, ActivityType as aG, OrderActivityTypeEnumActivityType as aH, AttributionSource as aI, ChannelType as aJ, AdditionalFeeSource as aK, OrderActionType as aL, SpecificItemsCouponBehavior as aM, ChargeType as aN, VersioningMode as aO, DeltaPaymentOptionType as aP, InventoryAction as aQ, WebhookIdentityType as aR, ScheduledAction as aS, DurationUnit as aT, PaymentCollectabilityStatus as aU, PredefinedPaymentMethod as aV, RefundableStatus as aW, NonRefundableReason as aX, ManuallyRefundableReason as aY, RestockType as aZ, TransactionStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type ServiceProperties as b$, AuthorizationVoidStatus as b0, Reason as b1, ActionType as b2, ChargebackStatus as b3, MembershipPaymentStatus as b4, PaymentStatus as b5, CanceledReason as b6, DeclinedReason as b7, VoidedReason as b8, RefundStatus as b9, type Dimensions as bA, type ItemType as bB, type ItemTypeItemTypeDataOneOf as bC, type RestockLocation as bD, type ItemTaxFullDetails as bE, type LineItemTaxInfo as bF, type LineItemTaxBreakdown as bG, type DigitalFile as bH, type SubscriptionInfo as bI, type SubscriptionTitle as bJ, type SubscriptionDescription as bK, type SubscriptionSettings as bL, type FreeTrialPeriod as bM, type BillingSettings as bN, type BillingAdjustment as bO, type BillingAdjustmentPriceSummary as bP, type CyclePriceOverride as bQ, type PriceDescription as bR, type LocationAndQuantity as bS, type TaxableAddress as bT, type TaxableAddressTaxableAddressDataOneOf as bU, type DecimalQuantity as bV, type DecimalQuantityUnitOneOf as bW, type TranslatableString as bX, type ExtendedFields as bY, type ModifierGroup as bZ, type ItemModifier as b_, PreviewEmailType as ba, State as bb, SiteCreatedContext as bc, Namespace as bd, DeleteStatus as be, Origin as bf, SortOrder as bg, OrderApprovalStrategy as bh, Placement as bi, SubdivisionType as bj, SourceType as bk, CustomFieldGroup as bl, ValueType as bm, DepositType as bn, InvoiceStatus as bo, type OrderLineItem as bp, type ProductName as bq, type CatalogReference as br, type DescriptionLine as bs, type DescriptionLineValueOneOf as bt, type DescriptionLineDescriptionLineValueOneOf as bu, type DescriptionLineName as bv, type PlainTextValue as bw, type Color as bx, type FocalPoint as by, type PhysicalProperties as bz, type SetOrderNumberCounterApplicationErrors as c, type AuthorizedPaymentCreated as c$, type CrossBorderPriceAdjustment as c0, type BuyerInfo as c1, type BuyerInfoIdOneOf as c2, type CurrencyConversionDetails as c3, type CrossBorderRepricing as c4, type PriceSummary as c5, type AddressWithContact as c6, type Address as c7, type StreetAddress as c8, type AddressLocation as c9, type Activity as cA, type ActivityContentOneOf as cB, type CustomActivity as cC, type MerchantComment as cD, type OrderRefunded as cE, type OrderCreatedFromExchange as cF, type NewExchangeOrderCreated as cG, type LineItemExchangeData as cH, type DraftOrderChangesApplied as cI, type OrderChange as cJ, type OrderChangeValueOneOf as cK, type LineItemChanges as cL, type LineItemQuantityChange as cM, type LineItemPriceChange as cN, type LineItemProductNameChange as cO, type LineItemDescriptionLineChange as cP, type LineItemModifiersChange as cQ, type ManagedLineItem as cR, type ManagedDiscount as cS, type TranslatedValue as cT, type LineItemAmount as cU, type ManagedAdditionalFee as cV, type TotalPriceChange as cW, type ShippingInformationChange as cX, type ShippingInformation as cY, type PricesRecalculatedForDestination as cZ, type SavedPaymentMethod as c_, type FullAddressContactDetails as ca, type VatId as cb, type V1ShippingInformation as cc, type DeliveryLogistics as cd, type DeliveryLogisticsAddressOneOf as ce, type PickupDetails as cf, type PickupAddress as cg, type DeliveryTimeSlot as ch, type ShippingPrice as ci, type ShippingRegion as cj, type TaxSummary as ck, type OrderTaxInfo as cl, type OrderTaxBreakdown as cm, type CrossBorderCalculation as cn, type AppliedDiscount as co, type AppliedDiscountDiscountSourceOneOf as cp, type Coupon as cq, type CouponDiscountValueOneOf as cr, type MerchantDiscount as cs, type MerchantDiscountMerchantDiscountReasonOneOf as ct, type DiscountRule as cu, type DiscountRuleDiscountValueOneOf as cv, type DiscountRuleName as cw, type LineItemDiscount as cx, type ItemCombination as cy, type ItemCombinationLineItem as cz, type PreparePaymentCollectionOptions as d, type OrderRejectedEventOrderRejected as d$, type AuthorizedPaymentCaptured as d0, type AuthorizedPaymentVoided as d1, type RefundInitiated as d2, type RefundedPayment as d3, type RefundedPaymentKindOneOf as d4, type RegularPaymentRefund as d5, type GiftCardPaymentRefund as d6, type MembershipPaymentRefund as d7, type PaymentRefunded as d8, type PaymentRefundFailed as d9, type AdditionalFee as dA, type FulfillmentStatusesAggregate as dB, type Tags as dC, type TagList as dD, type Location as dE, type OrderSettings as dF, type OrderSettingsAllowedActionsOneOf as dG, type OrderSettingsEditableByOneOf as dH, type CustomAllowedActions as dI, type OwnerApps as dJ, type FormInfo as dK, type FormIdentifier as dL, type PlatformFeeSummary as dM, type PlatformFee as dN, type UpdateInternalDocumentsEvent as dO, type UpdateInternalDocumentsEventOperationOneOf as dP, type InternalDocument as dQ, type InternalDocumentUpdateOperation as dR, type DeleteByIdsOperation as dS, type DeleteByFilterOperation as dT, type InternalDocumentUpdateByFilterOperation as dU, type InternalUpdateExistingOperation as dV, type VersionedDocumentUpdateOperation as dW, type VersionedDeleteByIdsOperation as dX, type VersionedDocumentId as dY, type OrderApproved as dZ, type OrdersExperiments as d_, type RefundedAsStoreCredit as da, type PaymentPending as db, type PaymentPendingPaymentDetailsOneOf as dc, type RegularPayment as dd, type RegularPaymentPaymentMethodDetailsOneOf as de, type CreditCardDetails as df, type PaymentCanceled as dg, type PaymentCanceledPaymentDetailsOneOf as dh, type PaymentDeclined as di, type PaymentDeclinedPaymentDetailsOneOf as dj, type ReceiptCreated as dk, type ReceiptCreatedReceiptInfoOneOf as dl, type WixReceipt as dm, type ExternalReceipt as dn, type ReceiptSent as dp, type ReceiptSentReceiptInfoOneOf as dq, type ChargebackCreated as dr, type ChargebackReversed as ds, type CreatedBy as dt, type CreatedByStringOneOf as du, type ChannelInfo as dv, type CustomField as dw, type BalanceSummary as dx, type Balance as dy, type CashRounding as dz, type PreparePaymentCollectionResponse as e, type ChargeMembershipsRequest as e$, type OrderItemsRestocked as e0, type V1RestockItem as e1, type OrderImported as e2, type ImportedOrderDeleted as e3, type PaymentStatusUpdated as e4, type FulfillmentStatusUpdated as e5, type OrderCanceledEventOrderCanceled as e6, type OrderDeltasCommitted as e7, type CommittedDiffs as e8, type CommittedDiffsShippingUpdateInfoOneOf as e9, type AccountInfo as eA, type ImportOrderRequest as eB, type SetOrderNumberCounterRequest as eC, type BulkDeleteImportedOrdersRequest as eD, type V1TriggerReindexRequest as eE, type V1TriggerReindexResponse as eF, type V1TriggerReindexOrderRequest as eG, type PreparePaymentCollectionRequest as eH, type RedirectUrls as eI, type DelayedCaptureSettings as eJ, type Duration as eK, type GetPaymentCollectabilityStatusRequest as eL, type RecordManuallyCollectedPaymentRequest as eM, type UserDefinedPaymentMethodName as eN, type UserDefinedPaymentMethodNameKindOneOf as eO, type RecordManuallyCollectedPaymentResponse as eP, type MarkOrderAsPaidRequest as eQ, type BulkMarkOrdersAsPaidRequest as eR, type BulkOrderResult as eS, type ItemMetadata as eT, type ApplicationError as eU, type BulkActionMetadata as eV, type GetRefundabilityStatusRequest as eW, type Refundability as eX, type RefundabilityAdditionalRefundabilityInfoOneOf as eY, type CreatePaymentGatewayOrderRequest as eZ, type ChargedBy as e_, type ItemChangedDetails as ea, type OrderLineItemChangedDetails as eb, type DecimalQuantityUpdate as ec, type CrossBorderAdjustmentUpdate as ed, type LineItemDelta as ee, type LineItemDeltaDeltaOneOf as ef, type AppliedDiscountDelta as eg, type AppliedDiscountDeltaDeltaOneOf as eh, type AdditionalFeeDelta as ei, type AdditionalFeeDeltaDeltaOneOf as ej, type DraftOrderCommitSettings as ek, type InventoryUpdateDetails as el, type TriggerReindexRequest as em, type TriggerReindexResponse as en, type DomainEvent as eo, type DomainEventBodyOneOf as ep, type EntityCreatedEvent as eq, type RestoreInfo as er, type EntityUpdatedEvent as es, type EntityDeletedEvent as et, type ActionEvent as eu, type Empty as ev, type TriggerReindexOrderRequest as ew, type MessageEnvelope as ex, type IdentificationData as ey, type IdentificationDataIdOneOf as ez, type PreparePaymentCollectionApplicationErrors as f, type BulkSendBuyerShippingConfirmationEmailsResponse as f$, type MembershipChargeItem as f0, type MembershipName as f1, type ChargeMembershipsResponse as f2, type TriggerRefundRequest as f3, type RefundDetails as f4, type RefundItem as f5, type LineItemRefund as f6, type AdditionalFeeRefund as f7, type ShippingRefund as f8, type RefundSideEffects as f9, type PaymentStatusDetails as fA, type PaymentStatusDetailsStatusDetailsOneOf as fB, type Refund as fC, type RefundTransaction as fD, type RefundStatusInfo as fE, type AggregatedRefundSummary as fF, type RefundItemsBreakdown as fG, type LineItemRefundSummary as fH, type CalculateRefundRequest as fI, type CalculateRefundItemRequest as fJ, type CalculateRefundResponse as fK, type CalculateRefundItemResponse as fL, type VoidAuthorizedPaymentsRequest as fM, type CaptureAuthorizedPaymentsRequest as fN, type ChargeSavedPaymentMethodRequest as fO, type ChargeSavedPaymentMethodResponse as fP, type SendBuyerConfirmationEmailRequest as fQ, type SendBuyerConfirmationEmailResponse as fR, type SendBuyerPaymentsReceivedEmailRequest as fS, type SendBuyerPaymentsReceivedEmailResponse as fT, type SendBuyerPickupConfirmationEmailRequest as fU, type SendBuyerPickupConfirmationEmailResponse as fV, type BulkSendBuyerPickupConfirmationEmailsRequest as fW, type BulkSendBuyerPickupConfirmationEmailsResponse as fX, type SendBuyerShippingConfirmationEmailRequest as fY, type SendBuyerShippingConfirmationEmailResponse as fZ, type BulkSendBuyerShippingConfirmationEmailsRequest as f_, type RestockInfo as fa, type RestockItem as fb, type OrderTransactions as fc, type Payment as fd, type PaymentPaymentDetailsOneOf as fe, type PaymentReceiptInfoOneOf as ff, type PaymentStatusDetailsOneOf as fg, type RegularPaymentDetails as fh, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fi, type CreditCardPaymentMethodDetails as fj, type AuthorizationDetails as fk, type AuthorizationCapture as fl, type AuthorizationActionFailureDetails as fm, type AuthorizationVoid as fn, type V1ScheduledAction as fo, type Chargeback as fp, type PaymentMethodName as fq, type GiftCardPaymentDetails as fr, type MembershipPaymentDetails as fs, type FutureMembershipDetails as ft, type WixReceiptInfo as fu, type ExternalReceiptInfo as fv, type CashRoundingDetails as fw, type CanceledStatusDetails as fx, type DeclinedStatusDetails as fy, type VoidedStatusDetails as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type AddToAutomationMigrationPopulationRequest as g$, type SendMerchantOrderReceivedNotificationRequest as g0, type SendMerchantOrderReceivedNotificationResponse as g1, type SendCancelRefundEmailRequest as g2, type SendCancelRefundEmailResponse as g3, type SendRefundEmailRequest as g4, type SendRefundEmailResponse as g5, type SendFulfillmentEmailRequest as g6, type SendFulfillmentEmailResponse as g7, type SendMerchantOrderReceivedPushRequest as g8, type SendMerchantOrderReceivedPushResponse as g9, type SitePublished as gA, type SiteUnpublished as gB, type SiteMarkedAsTemplate as gC, type SiteMarkedAsWixSite as gD, type ServiceProvisioned as gE, type ServiceRemoved as gF, type SiteRenamed as gG, type SiteHardDeleted as gH, type NamespaceChanged as gI, type StudioAssigned as gJ, type StudioUnassigned as gK, type SiteUrlChanged as gL, type SitePurgedExternally as gM, type OdeditorAssigned as gN, type OdeditorUnassigned as gO, type PicassoAssigned as gP, type PicassoUnassigned as gQ, type WixelAssigned as gR, type WixelUnassigned as gS, type StudioTwoAssigned as gT, type StudioTwoUnassigned as gU, type UserDomainMediaEnabled as gV, type UserDomainMediaDisabled as gW, type EditorlessAssigned as gX, type EditorlessUnassigned as gY, type HasCustomEmailConfigurationsRequest as gZ, type HasCustomEmailConfigurationsResponse as g_, type PreviewEmailByTypeRequest as ga, type PreviewEmailByTypeResponse as gb, type PreviewRefundEmailRequest as gc, type PreviewRefundEmailResponse as gd, type PreviewCancelEmailRequest as ge, type PreviewCancelEmailResponse as gf, type PreviewCancelRefundEmailRequest as gg, type PreviewCancelRefundEmailResponse as gh, type PreviewBuyerPaymentsReceivedEmailRequest as gi, type PreviewBuyerPaymentsReceivedEmailResponse as gj, type PreviewBuyerConfirmationEmailRequest as gk, type PreviewBuyerConfirmationEmailResponse as gl, type PreviewBuyerPickupConfirmationEmailRequest as gm, type PreviewBuyerPickupConfirmationEmailResponse as gn, type PreviewShippingConfirmationEmailRequest as go, type PreviewShippingConfirmationEmailResponse as gp, type PreviewResendDownloadLinksEmailRequest as gq, type PreviewResendDownloadLinksEmailResponse as gr, type MetaSiteSpecialEvent as gs, type MetaSiteSpecialEventPayloadOneOf as gt, type Asset as gu, type SiteCreated as gv, type SiteTransferred as gw, type SiteDeleted as gx, type DeleteContext as gy, type SiteUndeleted as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type UpdateOrderLineItemsResponse as h$, type AddToAutomationMigrationPopulationResponse as h0, type IsInAutomationMigrationPopulationRequest as h1, type IsInAutomationMigrationPopulationResponse as h2, type DiffmatokyPayload as h3, type ErrorInformation as h4, type GetOrderRequest as h5, type GetOrderResponse as h6, type InternalQueryOrdersRequest as h7, type PlatformQuery as h8, type PlatformQueryPagingMethodOneOf as h9, type V1LineItemDelta as hA, type V1LineItemDeltaDeltaOneOf as hB, type CommitDeltasResponse as hC, type ArchiveOrderRequest as hD, type ArchiveOrderResponse as hE, type BulkArchiveOrdersRequest as hF, type BulkArchiveOrdersResponse as hG, type BulkArchiveOrdersByFilterRequest as hH, type BulkArchiveOrdersByFilterResponse as hI, type UnArchiveOrderRequest as hJ, type UnArchiveOrderResponse as hK, type BulkUnArchiveOrdersRequest as hL, type BulkUnArchiveOrdersResponse as hM, type BulkUnArchiveOrdersByFilterRequest as hN, type BulkUnArchiveOrdersByFilterResponse as hO, type UpdateBuyerInfoRequest as hP, type BuyerInfoUpdate as hQ, type UpdateBuyerInfoResponse as hR, type UpdateBuyerEmailRequest as hS, type UpdateBuyerEmailResponse as hT, type UpdateOrderShippingAddressRequest as hU, type UpdateOrderShippingAddressResponse as hV, type UpdateBillingContactDetailsRequest as hW, type UpdateBillingContactDetailsResponse as hX, type UpdateOrderLineItemRequest as hY, type UpdateOrderLineItemsRequest as hZ, type MaskedOrderLineItem as h_, type Sorting as ha, type PlatformPaging as hb, type CursorPaging as hc, type InternalQueryOrdersResponse as hd, type PlatformPagingMetadata as he, type Cursors as hf, type QueryOrderRequest as hg, type QueryOrderResponse as hh, type SearchOrdersRequest as hi, type CursorSearch as hj, type CursorSearchPagingMethodOneOf as hk, type CursorPagingMetadata as hl, type CreateOrderRequest as hm, type OrderCreationSettings as hn, type OrderCreationSettingsEditableByOneOf as ho, type OrderCreateNotifications as hp, type CreateOrderResponse as hq, type UpdateOrderRequest as hr, type UpdateOrderResponse as hs, type BulkUpdateOrdersRequest as ht, type CommitDeltasRequest as hu, type DraftOrderDiffs as hv, type DraftOrderDiffsShippingUpdateInfoOneOf as hw, type DraftOrderDiffsBuyerUpdateInfoOneOf as hx, type DraftOrderDiffsBillingUpdateInfoOneOf as hy, type DraftOrderDiffsRecipientUpdateInfoOneOf as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type DecrementItemsQuantityResponse as i$, type AddInternalActivityRequest as i0, type InternalActivity as i1, type InternalActivityContentOneOf as i2, type OrderPlaced as i3, type OrderPaid as i4, type OrderFulfilled as i5, type OrderNotFulfilled as i6, type OrderCanceled as i7, type DownloadLinkSent as i8, type TrackingNumberAdded as i9, type UpdateOrderStatusRequest as iA, type MarkAsFulfilledRequest as iB, type MarkAsFulfilledResponse as iC, type BulkMarkAsFulfilledRequest as iD, type BulkMarkAsFulfilledResponse as iE, type BulkMarkAsFulfilledByFilterRequest as iF, type BulkMarkAsFulfilledByFilterResponse as iG, type MarkAsUnfulfilledRequest as iH, type MarkAsUnfulfilledResponse as iI, type BulkMarkAsUnfulfilledRequest as iJ, type BulkMarkAsUnfulfilledResponse as iK, type BulkMarkAsUnfulfilledByFilterRequest as iL, type BulkMarkAsUnfulfilledByFilterResponse as iM, type BulkSetBusinessLocationRequest as iN, type BulkSetBusinessLocationResponse as iO, type BulkSetBusinessLocationResult as iP, type V1MarkOrderAsPaidRequest as iQ, type V1MarkOrderAsPaidResponse as iR, type V1BulkMarkOrdersAsPaidRequest as iS, type V1BulkMarkOrdersAsPaidResponse as iT, type V1CreatePaymentGatewayOrderRequest as iU, type V1CreatePaymentGatewayOrderResponse as iV, type GetShipmentsRequest as iW, type GetShipmentsResponse as iX, type AggregateOrdersRequest as iY, type DecrementItemsQuantityRequest as iZ, type DecrementData as i_, type TrackingNumberEdited as ia, type TrackingLinkAdded as ib, type ShippingConfirmationEmailSent as ic, type InvoiceAdded as id, type InvoiceSent as ie, type FulfillerEmailSent as ig, type ShippingAddressEdited as ih, type EmailEdited as ii, type PickupReadyEmailSent as ij, type OrderPartiallyPaid as ik, type OrderPending as il, type OrderRejected as im, type AddInternalActivityResponse as io, type AddActivityRequest as ip, type PublicActivityContentOneOf as iq, type AddActivitiesRequest as ir, type UpdateActivityRequest as is, type DeleteActivityRequest as it, type UpdateLineItemsDescriptionLinesRequest as iu, type LineItemUpdate as iv, type UpdateLineItemsDescriptionLinesResponse as iw, type MarkOrderAsSeenByHumanRequest as ix, type MarkOrderAsSeenByHumanResponse as iy, type CancelOrderRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type RepriceStatusWithLiterals as j$, type BulkUpdateOrderTagsRequest as j0, type TagsTags as j1, type TagsTagList as j2, type BulkUpdateOrderTagsResult as j3, type SendOrderUpdatedDomainEventRequest as j4, type SendOrderUpdatedDomainEventResponse as j5, type Task as j6, type TaskKey as j7, type TaskAction as j8, type TaskActionActionOneOf as j9, type ItemizedFee as jA, type Discount as jB, type DiscountOneDiscountTypeOneOf as jC, type CalculatedTaxes as jD, type CalculatedTax as jE, type Payments as jF, type InvoicesPayment as jG, type MetaData as jH, type InvoiceDynamicPriceTotals as jI, type CustomFieldValue as jJ, type Value as jK, type Deposit as jL, type BaseEventMetadata as jM, type EventMetadata as jN, type AccountInfoMetadata as jO, type OrderSearchSpec as jP, utils as jQ, type DescriptionLineTypeWithLiterals as jR, type DimensionsUnitWithLiterals as jS, type ItemTypePresetWithLiterals as jT, type PaymentOptionTypeWithLiterals as jU, type JurisdictionTypeWithLiterals as jV, type SubscriptionFrequencyWithLiterals as jW, type ProductPeriodAlignmentWithLiterals as jX, type AdjustmentTypeWithLiterals as jY, type TaxableAddressTypeWithLiterals as jZ, type MeasurementUnitWithLiterals as j_, type Complete as ja, type Cancel as jb, type Reschedule as jc, type InvoiceSentEvent as jd, type IdAndVersion as je, type InvoiceFields as jf, type Customer as jg, type Email as jh, type QuotesAddress as ji, type AddressDescription as jj, type Phone as jk, type Company as jl, type CommonAddress as jm, type CommonAddressStreetOneOf as jn, type Subdivision as jo, type StandardDetails as jp, type ShippingContactDetails as jq, type InvoiceDates as jr, type LineItems as js, type LineItem as jt, type BigDecimalWrapper as ju, type LineItemTax as jv, type Source as jw, type LineItemMetaData as jx, type Locale as jy, type TotalPrice as jz, type GetRefundabilityStatusResponse as k, onOrderCreated as k$, type BaseRateSourceWithLiterals as k0, type PaymentStatusEnumPaymentStatusWithLiterals as k1, type FulfillmentStatusWithLiterals as k2, type WeightUnitWithLiterals as k3, type VatTypeWithLiterals as k4, type PickupMethodWithLiterals as k5, type CrossBorderNotApplicableReasonWithLiterals as k6, type CrossBorderRepricingModeWithLiterals as k7, type DiscountTypeWithLiterals as k8, type DiscountValueTypeWithLiterals as k9, type ActionTypeWithLiterals as kA, type ChargebackStatusWithLiterals as kB, type MembershipPaymentStatusWithLiterals as kC, type PaymentStatusWithLiterals as kD, type CanceledReasonWithLiterals as kE, type DeclinedReasonWithLiterals as kF, type VoidedReasonWithLiterals as kG, type RefundStatusWithLiterals as kH, type PreviewEmailTypeWithLiterals as kI, type StateWithLiterals as kJ, type SiteCreatedContextWithLiterals as kK, type NamespaceWithLiterals as kL, type DeleteStatusWithLiterals as kM, type OriginWithLiterals as kN, type SortOrderWithLiterals as kO, type OrderApprovalStrategyWithLiterals as kP, type PlacementWithLiterals as kQ, type SubdivisionTypeWithLiterals as kR, type SourceTypeWithLiterals as kS, type CustomFieldGroupWithLiterals as kT, type ValueTypeWithLiterals as kU, type DepositTypeWithLiterals as kV, type InvoiceStatusWithLiterals as kW, type CommonSearchWithEntityContext as kX, onOrderApproved as kY, onOrderCanceled as kZ, onOrderCommitted as k_, type DiscountReasonWithLiterals as ka, type LineItemQuantityChangeTypeWithLiterals as kb, type ActivityTypeWithLiterals as kc, type OrderActivityTypeEnumActivityTypeWithLiterals as kd, type AttributionSourceWithLiterals as ke, type ChannelTypeWithLiterals as kf, type AdditionalFeeSourceWithLiterals as kg, type OrderActionTypeWithLiterals as kh, type SpecificItemsCouponBehaviorWithLiterals as ki, type ChargeTypeWithLiterals as kj, type VersioningModeWithLiterals as kk, type DeltaPaymentOptionTypeWithLiterals as kl, type InventoryActionWithLiterals as km, type WebhookIdentityTypeWithLiterals as kn, type ScheduledActionWithLiterals as ko, type DurationUnitWithLiterals as kp, type PaymentCollectabilityStatusWithLiterals as kq, type PredefinedPaymentMethodWithLiterals as kr, type RefundableStatusWithLiterals as ks, type NonRefundableReasonWithLiterals as kt, type ManuallyRefundableReasonWithLiterals as ku, type RestockTypeWithLiterals as kv, type TransactionStatusWithLiterals as kw, type AuthorizationCaptureStatusWithLiterals as kx, type AuthorizationVoidStatusWithLiterals as ky, type ReasonWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, onOrderFulfilled as l0, onOrderImported as l1, onOrderImportedOrderDeleted as l2, onOrderPaymentStatusUpdated as l3, onOrderUpdated as l4, importOrder as l5, setOrderNumberCounter as l6, bulkDeleteImportedOrders as l7, preparePaymentCollection as l8, getPaymentCollectabilityStatus as l9, recordManuallyCollectedPayment as la, paymentCollectionMarkOrderAsPaid as lb, paymentCollectionBulkMarkOrdersAsPaid as lc, getRefundabilityStatus as ld, paymentCollectionCreatePaymentGatewayOrder as le, chargeMemberships as lf, triggerRefund as lg, voidAuthorizedPayments as lh, captureAuthorizedPayments as li, getOrder as lj, createOrder as lk, updateOrder as ll, bulkUpdateOrders as lm, updateOrderLineItem as ln, addActivity as lo, addActivities as lp, updateActivity as lq, deleteActivity as lr, cancelOrder as ls, updateOrderStatus as lt, aggregateOrders as lu, bulkUpdateOrderTags as lv, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
|