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