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