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